Docs: Add comprehensive contributing guide and update README
- Add CONTRIBUTING.md with full development workflow documentation - Document branch naming conventions (feature/, docs/, fix/, etc.) - Add documentation standards and guidelines - Establish PR process and review criteria - Update README.md Contributing section to reference new guide - Prepare foundation for documentation restructuring work
This commit is contained in:
13
README.md
13
README.md
@@ -459,13 +459,22 @@ For issues or questions:
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! Please:
|
||||
Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines on:
|
||||
|
||||
- Development workflow
|
||||
- Branch management
|
||||
- Documentation standards
|
||||
- Code quality requirements
|
||||
- Pull request process
|
||||
|
||||
**Quick Start:**
|
||||
1. Fork the repository
|
||||
2. Create a feature branch
|
||||
2. Create a feature branch: `git checkout -b feature/your-feature-name`
|
||||
3. Make your changes and test thoroughly
|
||||
4. Submit a pull request with a clear description
|
||||
|
||||
For full details, see [CONTRIBUTING.md](CONTRIBUTING.md).
|
||||
|
||||
## Authors
|
||||
|
||||
- Ryan Parmeter ([@parkingmeter](https://git.parkingmeter.info/parkingmeter))
|
||||
|
||||
Reference in New Issue
Block a user