#How to contribute
GenomicsDB is released under the MIT License. Hence, we expect the external contributors to grant an MIT License for their contributions. We have adopted the Developer Certificate of Origin from the Linux project, and request the developer to include a 'Signed-off-by' line in the commit message to indicate they understand and agree to the DCO.
Signed-off-by: First Last [email protected] (github: developer_githubid)
We are excited you are interested in improving the sample APIs Thanks for taking the interest and time!
The code layout is described in the README.
We are somewhat loose on coding style. Generally try to stay consistent with the naming, spacing, and layout of the language as used thus far.
Generally pep8 is a good goal, but not an absolute requirement. Line length is done for readability, so not strictly 79 chars.
- Functions are usually named with under_scores or mixedCase.
- Classes are usually named with CapitalizedWords
- variables are usually named with lowercase
- autoflake and autopep are useful tools to get the broad strokes.
- Pull Requests should be limited to a feature or bug fix.
- Create a branch in which to work.
- Submit a PR back to master.
- Once it is tested and checked, the PR can be accepted and merged into master.
Best effort should be made to maintain or improve the code coverage with each PR. Please write new unit tests were appropriate for new functions.
To test the ansible code, and perform end to end testing, we use serverspec. Please write new tests to cover new functionality, endpoints, edge cases, and install artifacts. For examples, see the spec directory in each role under infrastructure/ansible.
For python use pytest.
To be added as questions are frequently asked
If you have any questions, checkout out the Questions section. Most of our documentation is in the project wiki
If you have any further questions, contact the project maintainers or authors.