👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to DeepSampler on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
PullRequests are welcome!
We follow the standard procedure for contributing on GitHub. Described from the perspective of contributers, we usually follow these steps:
- Create a fork of DeepSamplers main repository
- Pull the fork into your local IDE
- Make your changes
- Ensure that the Definition of Done is fullfilled
- Create a PullRequest for the main repository
- Follow the review process guided by GitHub
- Done!
An in-depth tutorial on how to use pullrequests and forks can be found here: GitHub Standard Fork & Pull Request Workflow
We like to keep plugins in separated repositories. We want to keep the main repository as small and simple as possible and we want to ensure a clear separation between the general framework and specific plugins.
Using separated repositories also gives the authors the opportunity to keep the ownership and to be seen as contributors to the open source communitity, which we believe to be a quite honorably thing.
- Tests are green
- Technical test coverage is >80%. We even try to get above 90%.
- Sonarcloud qualitygate is passed
- Public methods are documented. Basic design-principles are explained in javadoc.
- Peerreview is completed