We welcome contributions from anyone interested in helping us improve the Spheron Documentation. If you have ideas for new features, bug fixes, and improvements to the documentation, please follow the guidelines below to get started.
Please be respectful and professional when contributing to the Spheron Documentation. We expect all the contributors to follow our code of conduct, which can be found in the code-of-conduct.md file.
If you have any questions or need clarification on an issue, please contact the maintainers through Discord.
Before making any changes, please fork the Documentation repository and create a new branch for your changes. There are two ways to name a branch:
- feat/your-branch-name: for new features
- fix/your-branch-name: for bug fixes.
Use a descriptive branch name that reflects the changes you plan to make.
Please follow the Spheron Documentation coding standards below. It is recommended to use prettier to format the code for all the files. Add appropriate comment lines where necessary, explaining what you intend to do properly.
When you are ready to make changes, please create a pull request on GitHub. Provide a detailed description of what you have done and why. Maintainers will review your changes and provide you with feedback.
After submitting your changes, please keep your fork up to date with the latest changes made to the Documentation repository. This will ensure that your contributions are compatible with the project's latest version.