Hello and welcome to our documentation contribution page! We appreciate your interest in helping us improve our tutorials. Below, you'll find a guide on how to contribute to our English documentation.
Getting Started
Familiarize Yourself with the Documentation
Before you start contributing, it's important to read through the existing tutorials and get a sense of our style and content.Create an Account on Our Repository
To submit changes, you'll need an account on our repository. Sign up here.Fork the Repository
Once you have an account, fork the repository to your own GitHub account.Create a New Branch
For each contribution, create a new branch from the main branch.Make Your Changes
Now you can make your changes. Remember to keep your commits focused on a single change.Test Your Changes
Make sure to test your changes thoroughly to ensure they work as expected.
Common Tasks
- Fixing typos and grammatical errors
- Updating outdated information
- Adding new tutorials
- Improving the formatting and readability
Tips for Writing Good Documentation
- Be Clear and Concise: Use simple language and avoid jargon.
- Be Consistent: Follow our style guide and use consistent terminology.
- Include Examples: Provide code snippets or screenshots to illustrate your points.
Contributing to the Community
We believe that contributing to documentation is a valuable way to give back to the community. Your contributions will help others learn and use our product more effectively.
The documentation team is always looking for new contributors!
For more information on contributing to our documentation, check out our Developer Guide.