4. Contribution Guide¶
Everyone is welcome to contribute!
If you plan to contribute to this project, please comply with the following guidelines:
4.1. Contribution Guidelines¶
Before starting, get a sense of which functionality and modules are already included in modlAMP and read the documentation. If you then still think, your idea is missing, go for it!
- Comply with the used docstring format (rst, check the existing code and comment in the same way) –> documentation is automatically generated
- If you extend an existing module/class/function, use the same variable names.
- For all of your new modules/classes/functions, make Unittest test cases, otherwise nobody knows, whether your feature actually works!
- Include code examples of how to use your amazing new feature / add a section to the
README
file
4.1.1. Reporting Bugs¶
Before reporting a bug: are you sure, that the bug is persistent? Does it only occur on your machine? If the bug persists, do the following:
- Create a new issue (left menu GitLab server)
- Use a clear and descriptive title
- Describe the exact steps that produced the problem
- Provide examples
- Explain which behaviour you actually expected to see
4.1.2. Git Workflow To Contribute¶
clone a version of the current Git repository to your local machine
create a new git branch for your project:
git branch <branch-name>
change to your new branch:
git checkout <branch-name>
start implementing your amazing new feature!
regularly
git add
andgit commit
- if you feel like your amazing new feature is ready to be used by others, push your branch back to the origin:
git push origin <branch-name>
- if your finished implementing the feature, create a merge request on the GitLab server to include your branch
into the master branch.