Become a Contributor

Thank you for considering contributing to our project! We welcome contributions from everyone, whether you're a seasoned developer or just starting out. By contributing, you help improve the project for everyone.

Before you start contributing, please take a moment to review our guidelines to ensure a smooth process:

Code of Conduct

Please read and adhere to our Code of Conduct (opens in a new tab) to ensure a friendly and inclusive community.

Contributor Guidelines

  • Accuracy: Ensure that all information provided is accurate and up-to-date.

  • Clarity: Write in clear and understandable language, avoiding unnecessary jargon or technical terms when possible.

  • Completeness: Cover all relevant aspects of the topic being discussed, providing comprehensive guidance to readers.

  • Formatting: Follow the established Style Guidelines (opens in a new tab) to maintain consistency across the documentation.

    The Style Guidelines are here to help you and the end user. Please consult them throughout your development.

    For more examples: Styling Guide (opens in a new tab).

What You Can Contribute

  • Submit Feedback: If you notice any errors, inaccuracies, or areas for improvement in our existing documentation, please let us know by opening an issue (opens in a new tab) or submitting feedback (opens in a new tab) on our GitHub repository.

  • Write Guides: Have a topic you're passionate about or experienced in? Write a guide to share your knowledge with others. We accept contributions for new guides as well as updates to existing ones.

  • Review and Edit: Even if you're not writing guides yourself, you can still contribute by reviewing and editing existing content. Help ensure accuracy, clarity, and completeness.

  • Spread the Word: Share our documentation with others who might find it useful. The more people who contribute and benefit from our resources, the better our documentation becomes.

How to Contribute

Fork the Repository

If you do not have a GitHub account already, start by creating one here (opens in a new tab).

Start by forking the project repository to your own GitHub account. You can do so by going to the original repository (opens in a new tab) and create a fork from there.

repo_forking

Clone the Repository

Clone your forked repository to your local machine using Git.

git clone https://github.com/your-username/project-name.git

Create a Branch

Create a new branch for your contribution.

git checkout -b feature/your-feature-name

Make Changes

Make your desired changes to the codebase.

Test Your Changes

Ensure that your changes work as expected and do not introduce any new issues.

⚠️

This is not optional, guides that introduce new issues, or are untested will NOT be merged.

Commit Your Changes

Commit your changes with a clear and descriptive commit message.

git commit -m "Add feature: your feature description"

Push Changes

Push your changes to your forked repository.

git push origin feature/your-feature-name

Submit a Pull Request

Go to the original repository (opens in a new tab) and create a pull request with a detailed description of your changes.

Support

For any questions or feedback, feel free to reach out to support (opens in a new tab), or contact me directly here (opens in a new tab).

We appreciate your interest in contributing to our project! 🎉