This repository contains the source code for the Open Source Twitch API Documentation i18n Website, a community-driven project aimed at providing translated documentation for the Twitch API. The website is built using Nextra, a modern static website generator written in Next.js.
We are always looking for contributors to help us improve and expand the translated documentation. If you'd like to contribute, please follow these steps:
-
Fork the repository by clicking the "Fork" button at the top-right corner of this page.
-
Clone your fork of the repository to your local machine:
git clone https://github.com/dokdo2013/twitch-docs-i18n.git
- Change to the project directory:
cd twitch-docs-i18n
- Create your feature branch:
git checkout -b my-new-feature
-
Make your changes and improvements to the documentation. Please make sure that your contributions follow the established documentation structure and language guidelines.
-
Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Visit your fork on GitHub and create a new Pull Request by clicking the "Compare & pull request" button.
When contributing translations, please follow these guidelines:
- Use formal language and avoid using slang or colloquial expressions.
- Keep the translations as close as possible to the original English text.
- Maintain a consistent formatting and style throughout the documentation.
We are committed to fostering a welcoming and inclusive environment for everyone. Please read and follow our Code of Conduct to ensure that our community remains a safe and enjoyable place for everyone to collaborate.
-
Be respectful and considerate: Treat others the way you would like to be treated. Be kind and professional, and always assume good intentions from others.
-
Communicate effectively: Use clear and concise language, and be open to feedback from others. Avoid using slang, jargon, or colloquial expressions that may not be understood by everyone in the community.
-
Collaborate and be inclusive: Actively seek out diverse perspectives and include as many people as possible in discussions and decision-making. Encourage newcomers to participate and help them feel welcome.
-
Stay on topic: Keep conversations relevant to the project and avoid derailing discussions with unrelated or controversial subjects.
-
No harassment, discrimination, or inappropriate behavior: Any form of harassment, discrimination, or inappropriate behavior based on race, gender, sexual orientation, disability, or any other personal characteristic will not be tolerated.
-
Respect privacy: Do not share personal information about others without their explicit consent.
-
Report misconduct: If you witness or experience any violations of this Code of Conduct, please report them to the project maintainers.
By participating in this project, you agree to abide by these rules and to follow the Code of Conduct. Failure to do so may result in a warning, temporary suspension, or permanent removal from the project, at the discretion of the project maintainers.
This project is licensed under the MIT License. See the LICENSE
file for more information.