Contributing to the Documentation
Ce contenu n’est pas encore disponible dans votre langue.
Thank you for your interest in contributing to “Refactoring is My Business”! This guide will help you get started.
How to Contribute
Section titled “How to Contribute”1. Reporting Issues
Section titled “1. Reporting Issues”If you find an error or inconsistency in the documentation, please open an issue with:
- A clear and descriptive title.
- A detailed description of the issue.
- Code examples or screenshots, if applicable.
2. Suggesting Improvements
Section titled “2. Suggesting Improvements”To propose changes or add new content:
- Fork the repository.
- Create a dedicated branch:
Terminal window git checkout -b feat/my-new-section - Edit or add content in the
refactoring-is-my-business.mdxfile. - Submit a Pull Request (PR) to the
mainbranch.
3. Contribution Guidelines
Section titled “3. Contribution Guidelines”- Follow the style: Use clear, professional language.
- Be concise: Avoid redundancy and overly verbose explanations.
- Test your changes: Ensure your updates are accurate and functional.
- Reference sources: If you add external content, cite your sources.
4. Code of Conduct
Section titled “4. Code of Conduct”By participating, you agree to uphold our Code of Conduct. Be respectful and inclusive.
5. Need Help?
Section titled “5. Need Help?”If you have questions, feel free to ask in the Discussions section.
We appreciate your contributions and look forward to collaborating with you!