Contributing to CLA-Bot

Bugfixes or extensions to CLA-Bot or the existing CI/CD component are more than welcome. We encourage you to first file an issue for those to keep track of developments. Any extensions to the documentation are also very helpful since we will miss important points we are not aware of.

In general, please feel free to submit issues and enhancement requests. Since development of this component may not be our highest priority at times, please do not expect an immediate response but do not hesitate to remind us if you feel it takes too long.

Any issue, commit, branch, or merge request should ideally indicate the topic in an easy manner. Commits that refer to issues should do so from within the commit message.

Contributing code

First of all, please read about CI/CD components and best practices at docs.gitlab.com/ci/components for a general idea on how to create GitLab components.

Please refer to the currently used coding style when submitting patches and additions. In general, we aimt to follow the "fork-and-merge" Git workflow.

You will need an account on this GitLab instance and become member of a dedicated group for development of CLA-Bot. Only then can you fork the repository into this group. So please get in touch with us so we can arrange for that.

1. Fork the repository
2. Clone the project to your own machine
3. Commit changes to your own branch
4. Push your work back up to your fork
5. Submit a merge request so that we can review your changes (ideally referencing issues)
6. If you haven't before (unless you are a member of FZJ), accept CLA-Bot's CLA

NOTE: Be sure to merge the latest from "upstream" before making a merge request!

Run existing tests and ideally add new tests for new features or encountered errors. The CI pipeline will try and execute the component to provide feedback that way.

In case of any questions, please do not hesitate to get in touch with us.