CONTRIBUTING.md

spring-multi-data-source

Thank you for investing your time in contributing to this project!

General Steps to Contribute

1. Ensure you have Java 11 and Maven installed on your system.

2. Fork the project repository.

3. Clone the forked repository by running git clone <forked-repository-git-url>.

4. Navigate to your local repository by running cd spring-multi-data-source.

5. Pull the latest changes from upstream into your local repository by running git pull.

6. Create a new branch by running git checkout -b <new-branch-name>.

7. Make changes in your local repository to make the contribution you want.

8. Add relevant tests (if any) for the contribution you made to src/test folder in the appropriate sub-module.

9. Commit your changes and push them to your local repository by running git commit -am "my-commit-message" && git push origin <new-branch-name>.

10. Create a pull request on the original repository from your fork and wait for me to review (and hopefully merge) it. :)

Recommended Development Workflow

• Fork Project -> Create new Branch
• For each contribution in mind,
  • -> Develop Logical Change
  • -> Test
  • -> Ensure Documentation is sufficient
  • -> Commit
• Create Pull Request

Issue Based Contributions

Create a new issue

If you spot a problem or bug with the package, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See Labels for more information.

Overall Guidelines

• Contributions are welcome on GitHub. Please ensure all the tests are running before pushing your changes. Write your own tests too!

• File any issues or feature requests here, or help me resolve existing ones.