I'm really glad you're reading this, because we need volunteer developers to help this project come to fruition.
This is the Conviso Docs contributing guide. Please read the following sections to learn how to ask questions and how to work on something.
If you have a bug or an idea, check out the following sections before submitting your contribution. Writing a good issue will help our team better analyze and manage your contributions:
-
Bug Report: Create a report to help us improve
-
Feature request: Suggest a new feature for a project
-
Improvement: Suggest an improvement for a project
-
Support request: Support request or question relating to Docs
Try to explain the scenario to us by following these tips:
Context: Explain the conditions which led you to write this issue.
Problem or idea: The context should lead to something, an idea or a problem that you’re facing.
Solution or next step: This where you move forward. You can engage others (request feedback), assign somebody else to the issue, or simply leave it for further investigation, but you absolutely need to propose a next step towards solving the issue.
Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.
If you want to add an improvement, a new feature or bug fix, follow the steps to contribute:
- Step 1: Create your own fork of the code.
- Step 2: Do the changes in your fork. Make sure your branch, if you create one, is based on main.
- Step 3: Make your changes and open a GitHub pull request.
- Step 4: Make sure to write a title describing what you have done.
That's it, now just wait!
Do you have any questions about Conviso Docs? Let's chat in our Community. Thank you for your contribution.