This is CharlesCD's documentation contributing guide. We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.
1.1. Legal
5. Community
- CharlesCD's documentation is licensed over Creative Commons.
This project follows Google's Open Source Community Guidelines.
Check out the requisites before contributing to CharlesCD documentation:
This is a security layer for the project and for the developers. It is mandatory.
Follow one of these two methods to add DCO to your commits:
1. Command line Follow the steps: Step 1: Configure your local git environment adding the same name and e-mail configured at your GitHub account. It helps to sign commits manually during reviews and suggestions.
git config --global user.name “Name”
git config --global user.email “[email protected]”
Step 2: Add the Signed-off-by line with the '-s' flag in the git commit command:
$ git commit -s -m "This is my commit message"
2. GitHub website
You can also manually sign your commits during GitHub reviews and suggestions, follow the steps below:
Step 1: When the commit changes box opens, manually type or paste your signature in the comment box, see the example:
Signed-off-by: Name < e-mail address >
For this method, your name and e-mail must be the same registered on your GitHub account.
When you open a PR, follow the requisites below:
- You need to add a title describing the issue.
- Answer the questions about what you did, how to verify it and a description for the changelog, see an example:
You can suggest a change, a fix, or improvements to our documentation, such as:
- Add missing information.
- Fix a grammar or code error.
- Suggest a new section.
- Translate.
Follow the steps below:
Step 1. Access GitHub Issues and open an issue;
Step 2. Describe the issue or change you want to make;
Step 3. Make your changes;
Step 4. Open a pull request open a PR to the published branch, i. e., release-VERSION and fill in the template;
Step 5. CharlesCD's team will check your issue, review it, and then approve your PR.
- Is this the first CharlesCD repository you visit? Check out other repositories.
Every time that a new release is created, we save the current work into a new branch, called release-VERSION.
Please read the Code of Conduct.
Do you have any question about CharlesCD? Let's chat in our Zup Open Source Forum.