generated from Templates/Docker_Image
feat: initial release, refs NOISSUE
This commit is contained in:
73
ai_software_factory/CONTRIBUTING.md
Normal file
73
ai_software_factory/CONTRIBUTING.md
Normal file
@@ -0,0 +1,73 @@
|
||||
# Contributing to AI Software Factory
|
||||
|
||||
Thank you for your interest in contributing to the AI Software Factory project!
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
Please note that we have a Code of Conduct that all contributors are expected to follow.
|
||||
|
||||
## How to Contribute
|
||||
|
||||
### Reporting Bugs
|
||||
|
||||
Before creating bug reports, please check existing issues as the bug may have already been reported and fixed.
|
||||
|
||||
When reporting a bug, include:
|
||||
|
||||
- A clear description of the bug
|
||||
- Steps to reproduce the bug
|
||||
- Expected behavior
|
||||
- Actual behavior
|
||||
- Screenshots if applicable
|
||||
- Your environment details (OS, Python version, etc.)
|
||||
|
||||
### Suggesting Features
|
||||
|
||||
Feature suggestions are welcome! Please create an issue with:
|
||||
|
||||
- A clear title and description
|
||||
- Use cases for the feature
|
||||
- Any relevant links or references
|
||||
|
||||
### Pull Requests
|
||||
|
||||
1. Fork the repository
|
||||
2. Create a new branch (`git checkout -b feature/feature-name`)
|
||||
3. Make your changes
|
||||
4. Commit your changes (`git commit -am 'Add some feature'`)
|
||||
5. Push to the branch (`git push origin feature/feature-name`)
|
||||
6. Create a new Pull Request
|
||||
|
||||
### Style Guide
|
||||
|
||||
- Follow the existing code style
|
||||
- Add comments for complex logic
|
||||
- Write tests for new features
|
||||
- Update documentation as needed
|
||||
|
||||
## Development Setup
|
||||
|
||||
1. Clone the repository
|
||||
2. Create a virtual environment
|
||||
3. Install dependencies (`pip install -r requirements.txt`)
|
||||
4. Run tests (`make test`)
|
||||
5. Make your changes
|
||||
6. Run tests again to ensure nothing is broken
|
||||
|
||||
## Commit Messages
|
||||
|
||||
Follow the conventional commits format:
|
||||
|
||||
```
|
||||
feat: add new feature
|
||||
fix: fix bug
|
||||
docs: update documentation
|
||||
style: format code
|
||||
refactor: refactor code
|
||||
test: add tests
|
||||
chore: update dependencies
|
||||
```
|
||||
|
||||
## Questions?
|
||||
|
||||
Feel free to open an issue or discussion for any questions.
|
||||
Reference in New Issue
Block a user