Add Contributing guidelines

2025-01-09 06:27:53 +00:00
parent 20361bb053
commit dc8bd16ee8

125
Contributing-guidelines.md Normal file

@@ -0,0 +1,125 @@
# Contributing to the Tech Grimoire
Welcome, fellow artificer! Thank you for considering contributing to our collective knowledge base. This guide will help you understand our contribution process and standards.
## Ways to Contribute
### 1. Content Creation
- New articles
- Code examples
- Configuration templates
- Diagrams and visualizations
- Troubleshooting guides
### 2. Content Improvement
- Fix technical inaccuracies
- Update outdated information
- Improve clarity and readability
- Add missing examples
- Enhance existing documentation
### 3. Organization
- Improve categorization
- Add cross-references
- Create indexes
- Tag content appropriately
## Contribution Process
### 1. Getting Started
1. Fork the repository
2. Create a new branch for your changes
3. Review our [Style Guide](./style-guide.md)
4. Use appropriate [Templates](./templates.md)
### 2. Making Changes
1. Follow the style guide
2. Test all code examples
3. Verify technical accuracy
4. Include references
5. Add appropriate tags
### 3. Submitting Changes
1. Commit your changes with clear messages
2. Push to your fork
3. Create a pull request
4. Fill out the PR template
5. Await review
### 4. Review Process
1. Technical review
2. Style review
3. Address feedback
4. Final approval
## Quality Standards
### Content Requirements
- Technical accuracy is paramount
- Clear, concise writing
- Practical examples where applicable
- Proper formatting
- Appropriate cross-references
### Code Standards
- Working, tested code only
- Clear comments and documentation
- Follow language-specific best practices
- Include requirements and dependencies
- Error handling where appropriate
### Documentation Structure
- Clear introduction
- Logical flow
- Comprehensive coverage
- Practical examples
- Related resources
## Best Practices
### Do's
- Test all code examples
- Verify technical accuracy
- Include references
- Follow the style guide
- Cross-reference related content
- Use templates
- Add appropriate tags
### Don'ts
- Submit untested code
- Copy content without attribution
- Include sensitive information
- Submit incomplete articles
- Ignore the style guide
- Create duplicate content
## Communication
### Channels
- Issues for bugs and suggestions
- Discussions for questions
- Pull requests for changes
- Wiki comments for quick notes
### Guidelines
- Be respectful and professional
- Stay on topic
- Provide context
- Be patient with reviews
- Help others learn
## Recognition
Contributors will be acknowledged in:
- The contributors page
- Article attribution
- Release notes
- Special recognition for major contributions
## Questions?
- Review existing documentation
- Check discussions
- Open an issue for clarification
- Contact maintainers
Remember: Quality over quantity. Take your time to create valuable contributions that will help fellow tech mages in their journey.