| description |
|---|
Here you will find all that you need to know to start contributing to Rocket.Chat documentation. |
First of all, thank you for your interest in contributing to Rocket.Chat Docs. If this is the first Open Source project you will contribute to, we strongly suggest reading GitHub's excellent guide:
{% embed url="https://opensource.guide/how-to-contribute/" %}
You can find a list of issues here. When you find something you would like to work on just comment on it and we will add an In Progress label.
Rocket.Chat uses GitBook for documentation.
You can contribute to the docs by being invited into the GitBook online workspace or directly from your local environment. Follow this guide for a simple local environment setup
- Install any code editor of your choice, VSCode is the recommended
- Launch VSCode and install the Auto-Open Markdown Preview and markdownlint extensions. This will help with automatically formatting your changes and prompts for any errors
- Fork and clone the user docs or developers docs repository
- Open the project in VSCode and start making your changes
When you create a new pull request, we expect some requirements to be met.
- Follow this naming convention for Pull Requests:
- When adding new documentation, add New Documentation: before the title. E.g.
New Documentation: Authentication Guide - When fixing documentation, add Fix Documentation: before the title. E.g.
Fix Documentation: Authentication Guide - When updating documentation, add Update Documentation: before the title. E.g.
Update Documentation: Authentication Guide
- When adding new documentation, add New Documentation: before the title. E.g.
- If your Pull Request closes an issue you need to write
Closes #ISSUE_NUMBERwhere theISSUE_NUMBERis the number at the end of the link URL that will link your pull request to the issue, when merged will close that issue. - For each pull request made, we run tests to check if there are any broken links. You can find how to run these tests locally here.
When you create a new feature but for some reason can't create a full-fledged documentation pull request, you can create a draft which is a single file pull request with critical information needed to create the desired documentation, after creating the draft, the documentation team will edit the pull request to suit the documentation standards.
To test your changes you have 2 options:
The Auto-Open Markdown Preview installed on VSCode can help automatically preview directly in your editor.
Simply fork our docs repository, create a space on GitBook, and activate the GitHub Integration on your fork. This gives you a means of previewing your changes before submitting a PR.
We are looking for community maintainers for the Rocket.Chat documentation. Maintainers will be added to a special team with write permissions. These permissions consist of opening, closing, tagging, and editing issues and pull requests, creating and deleting non-protected branches on the docs repository.
The responsibilities of a maintainer are:
- Labeling issues: Label issues accordingly.
- Finding Duplicates: finding and closing duplicate issues.
- Closing irrelevant/inappropriate issues: Closing issues that are no longer needed, that are not relevant to the project, and/or don't follow the issues guidelines.
- Doing first-level contact: Getting more information on the issues (like version number or asking for clarification) and closing them if they aren't relevant or if a question made by the maintainer wasn't answered in 2 days.
- Help Manage Pull Requests: help the author of the pull request with any problems (like tests failing due to markdown problems on the pull request)
- Contributing! Create pull requests to help maintain the documentation