Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (54 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

72 lines (54 loc) · 2.76 KB

Contributing to SmartData

Thank you for your interest in contributing to SmartData – a general-purpose REST API for accessing databases, built in Java and deployed on a Payara Server. We welcome all kinds of contributions, whether you're fixing bugs, improving documentation, or adding new features.

Getting Started

  1. Fork the repository
    Click the "Fork" button at the top right to create your own copy of SmartData.

  2. Clone your fork locally

    git clone https://github.com/your-username/SmartData.git
cd SmartData

Create a new branch for your changes

git checkout -b feature/my-improvement
  • Make your changes
  • Use Java 11+ (unless otherwise specified)
  • Follow the existing code style and structure
  • Ensure compatibility with Payara Server deployment
  • Add unit or integration tests where appropriate
  • Commit and push your changes 
    git commit -m "Describe your changes here"
git push origin feature/my-improvement

Open a Pull Request

Go to the original SmartData repository at https://github.com/FlorianFehring/SmartData and click "Compare & pull request". Describe your changes clearly and reference any related issues.

Reporting Bugs and Issues

If you encounter a bug, unexpected behavior, or have a feature request, please open an issue under the Issues tab. Be sure to include:

  • A clear and descriptive title
  • Steps to reproduce the issue
  • Expected vs. actual behavior
  • Environment details (Java version, Payara version, OS)
  • Screenshots or logs if helpful

Contribution Guidelines

  • Keep your code clean, modular, and well-documented
  • Follow existing naming conventions and package structures
  • Write meaningful commit messages
  • Be respectful and constructive in discussions and reviews

Ways to Contribute

  • Report bugs or suggest features via Issues
  • Fix typos or improve documentation
  • Submit code improvements or new functionality
  • Review and comment on open pull requests

Team Collaboration Guidelines

Teams working on SmartData should organize their contributions as follows:

  • One team member forks the main repository (SmartData) and invites the others as collaborators via GitHub settings.
  • All team members work within this shared fork, using feature branches to separate tasks and avoid conflicts.
  • Changes should be submitted via Pull Requests and reviewed within the team before merging.
  • Each team is responsible for maintaining a clean and functional team branch that reflects their current progress.

This setup ensures smooth collaboration and a unified codebase per team.

License

By contributing, you agree that your contributions will be licensed under the same license as the project.