Welcome to the Contributing section of our Documentation! We appreciate your interest in helping us improve our resources. Below are some guidelines and steps to get you started.

Getting Started

  1. Familiarize Yourself with the Documentation Structure Before contributing, it's important to understand the structure of our documentation. You can find more information about the structure here.

  2. Create a GitHub Account If you don't already have one, sign up for a GitHub account.

  3. Fork the Repository Fork the Documentation repository to your own GitHub account.

  4. Create a New Branch For each contribution, create a new branch from the main branch.

  5. Make Your Changes Make your changes to the documentation. Remember to follow our Style Guide.

Editing the Documentation

  1. Use Markdown Our documentation is written in Markdown. You can find more information about Markdown here.

  2. Follow the Style Guide We have a Style Guide that outlines our preferred formatting and conventions.

  3. Use Consistent Terminology Make sure to use consistent terminology throughout the documentation.

Submitting Your Changes

  1. Commit Your Changes After making your changes, commit them to your branch.

  2. Create a Pull Request Open a pull request from your branch to the main branch.

  3. Review the Pull Request One of our maintainers will review your pull request. If any changes are needed, they will leave comments for you to address.

  4. Merge the Pull Request Once your changes are approved, the pull request will be merged into the main branch.

Additional Resources

Thank you for your contribution to our Documentation! Your help is greatly appreciated.

(center) Contributing Image (center)