-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
54 changed files
with
18,050 additions
and
17,741 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,57 +1,57 @@ | ||
# Code of Conduct | ||
|
||
Last Updated: November 19, 2024 | ||
|
||
## Our Pledge | ||
|
||
We as members, contributors, and leaders pledge to make participation in our | ||
community a harassment-free experience for everyone, regardless of age, body | ||
size, visible or invisible disability, ethnicity, sex characteristics, gender | ||
identity and expression, level of experience, education, socio-economic status, | ||
nationality, personal appearance, race, religion, or sexual identity | ||
and orientation. | ||
|
||
We pledge to act and interact in ways that contribute to an open, welcoming, | ||
diverse, inclusive, and healthy community. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to a positive environment: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior: | ||
|
||
* The use of sexualized language or imagery | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate | ||
|
||
## Enforcement Responsibilities | ||
|
||
Project maintainers are responsible for clarifying and enforcing standards of | ||
acceptable behavior and will take appropriate and fair corrective action in | ||
response to any behavior that they deem inappropriate, threatening, offensive, | ||
or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies within all community spaces, and also applies when | ||
an individual is officially representing the community in public spaces. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported to the project team at <[email protected]>. All complaints will be | ||
reviewed and investigated promptly and fairly. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), | ||
version 2.0, available at | ||
<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>. | ||
# Code of Conduct | ||
|
||
Last Updated: November 19, 2024 | ||
|
||
## Our Pledge | ||
|
||
We as members, contributors, and leaders pledge to make participation in our | ||
community a harassment-free experience for everyone, regardless of age, body | ||
size, visible or invisible disability, ethnicity, sex characteristics, gender | ||
identity and expression, level of experience, education, socio-economic status, | ||
nationality, personal appearance, race, religion, or sexual identity | ||
and orientation. | ||
|
||
We pledge to act and interact in ways that contribute to an open, welcoming, | ||
diverse, inclusive, and healthy community. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to a positive environment: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior: | ||
|
||
* The use of sexualized language or imagery | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate | ||
|
||
## Enforcement Responsibilities | ||
|
||
Project maintainers are responsible for clarifying and enforcing standards of | ||
acceptable behavior and will take appropriate and fair corrective action in | ||
response to any behavior that they deem inappropriate, threatening, offensive, | ||
or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies within all community spaces, and also applies when | ||
an individual is officially representing the community in public spaces. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported to the project team at <[email protected]>. All complaints will be | ||
reviewed and investigated promptly and fairly. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), | ||
version 2.0, available at | ||
<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,126 +1,126 @@ | ||
# Contributing to DevAssist Bot | ||
|
||
First off, thank you for considering contributing to DevAssist Bot! It's people like you that make DevAssist Bot such a great tool. | ||
|
||
## Code of Conduct | ||
|
||
This project and everyone participating in it is governed by our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. | ||
|
||
## How Can I Contribute? | ||
|
||
### Reporting Bugs | ||
|
||
1. Check if the bug has already been reported in [Issues](https://github.com/your-username/devassist-bot/issues) | ||
2. If not, create a new issue using the bug report template | ||
3. Include as much relevant information as possible: | ||
- Python version | ||
- Operating system | ||
- Steps to reproduce | ||
- Expected behavior | ||
- Actual behavior | ||
- Error messages | ||
|
||
### Suggesting Enhancements | ||
|
||
1. Check existing [Issues](https://github.com/your-username/devassist-bot/issues) for similar suggestions | ||
2. Create a new issue using the feature request template | ||
3. Describe the feature in detail: | ||
- Use cases | ||
- Expected behavior | ||
- Potential implementation approach | ||
|
||
### Pull Requests | ||
|
||
1. Fork the repository | ||
2. Create a new branch (`git checkout -b feature/amazing-feature`) | ||
3. Make your changes | ||
4. Run tests (`pytest tests/`) | ||
5. Update documentation | ||
6. Commit your changes (`git commit -m 'Add amazing feature'`) | ||
7. Push to the branch (`git push origin feature/amazing-feature`) | ||
8. Open a Pull Request | ||
|
||
## Development Setup | ||
|
||
1. Clone your fork: | ||
|
||
```bash | ||
git clone https://github.com/your-username/devassist-bot.git | ||
cd devassist-bot | ||
``` | ||
|
||
2. Create virtual environment: | ||
|
||
```bash | ||
python -m venv venv | ||
source venv/bin/activate # Linux/macOS | ||
venv\Scripts\activate # Windows | ||
``` | ||
|
||
3. Install dependencies: | ||
|
||
```bash | ||
pip install -r requirements.txt | ||
pip install -r requirements-dev.txt | ||
``` | ||
|
||
4. Set up pre-commit hooks: | ||
|
||
```bash | ||
pre-commit install | ||
``` | ||
|
||
## Coding Guidelines | ||
|
||
- Follow [PEP 8](https://www.python.org/dev/peps/pep-0008/) | ||
- Use type hints | ||
- Write docstrings for functions and classes | ||
- Add tests for new features | ||
- Keep functions small and focused | ||
- Use meaningful variable names | ||
|
||
## Testing | ||
|
||
- Write tests for new features | ||
- Ensure all tests pass before submitting PR | ||
- Maintain test coverage above 80% | ||
- Use pytest for testing | ||
|
||
## Documentation | ||
|
||
- Update relevant documentation | ||
- Add docstrings to new functions/classes | ||
- Update README if needed | ||
- Add examples for new features | ||
|
||
## Git Commit Messages | ||
|
||
- Use present tense ("Add feature" not "Added feature") | ||
- Use imperative mood ("Move cursor to..." not "Moves cursor to...") | ||
- Reference issues and pull requests | ||
- Keep first line under 72 characters | ||
- Describe what and why, not how | ||
|
||
## Review Process | ||
|
||
1. Automated checks must pass | ||
2. Code review by maintainers | ||
3. Documentation review | ||
4. Test coverage verification | ||
5. Final approval | ||
|
||
## Community | ||
|
||
- Join our [Discord server](https://discord.gg/your-invite) | ||
- Follow our [Twitter](https://twitter.com/your-handle) | ||
- Read our [blog](https://your-blog.com) | ||
|
||
## Recognition | ||
|
||
Contributors will be: | ||
|
||
- Listed in CONTRIBUTORS.md | ||
- Mentioned in release notes | ||
- Given special Discord roles | ||
|
||
Thank you for contributing! | ||
# Contributing to DevAssist Bot | ||
|
||
First off, thank you for considering contributing to DevAssist Bot! It's people like you that make DevAssist Bot such a great tool. | ||
|
||
## Code of Conduct | ||
|
||
This project and everyone participating in it is governed by our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. | ||
|
||
## How Can I Contribute? | ||
|
||
### Reporting Bugs | ||
|
||
1. Check if the bug has already been reported in [Issues](https://github.com/your-username/devassist-bot/issues) | ||
2. If not, create a new issue using the bug report template | ||
3. Include as much relevant information as possible: | ||
- Python version | ||
- Operating system | ||
- Steps to reproduce | ||
- Expected behavior | ||
- Actual behavior | ||
- Error messages | ||
|
||
### Suggesting Enhancements | ||
|
||
1. Check existing [Issues](https://github.com/your-username/devassist-bot/issues) for similar suggestions | ||
2. Create a new issue using the feature request template | ||
3. Describe the feature in detail: | ||
- Use cases | ||
- Expected behavior | ||
- Potential implementation approach | ||
|
||
### Pull Requests | ||
|
||
1. Fork the repository | ||
2. Create a new branch (`git checkout -b feature/amazing-feature`) | ||
3. Make your changes | ||
4. Run tests (`pytest tests/`) | ||
5. Update documentation | ||
6. Commit your changes (`git commit -m 'Add amazing feature'`) | ||
7. Push to the branch (`git push origin feature/amazing-feature`) | ||
8. Open a Pull Request | ||
|
||
## Development Setup | ||
|
||
1. Clone your fork: | ||
|
||
```bash | ||
git clone https://github.com/your-username/devassist-bot.git | ||
cd devassist-bot | ||
``` | ||
|
||
2. Create virtual environment: | ||
|
||
```bash | ||
python -m venv venv | ||
source venv/bin/activate # Linux/macOS | ||
venv\Scripts\activate # Windows | ||
``` | ||
|
||
3. Install dependencies: | ||
|
||
```bash | ||
pip install -r requirements.txt | ||
pip install -r requirements-dev.txt | ||
``` | ||
|
||
4. Set up pre-commit hooks: | ||
|
||
```bash | ||
pre-commit install | ||
``` | ||
|
||
## Coding Guidelines | ||
|
||
- Follow [PEP 8](https://www.python.org/dev/peps/pep-0008/) | ||
- Use type hints | ||
- Write docstrings for functions and classes | ||
- Add tests for new features | ||
- Keep functions small and focused | ||
- Use meaningful variable names | ||
|
||
## Testing | ||
|
||
- Write tests for new features | ||
- Ensure all tests pass before submitting PR | ||
- Maintain test coverage above 80% | ||
- Use pytest for testing | ||
|
||
## Documentation | ||
|
||
- Update relevant documentation | ||
- Add docstrings to new functions/classes | ||
- Update README if needed | ||
- Add examples for new features | ||
|
||
## Git Commit Messages | ||
|
||
- Use present tense ("Add feature" not "Added feature") | ||
- Use imperative mood ("Move cursor to..." not "Moves cursor to...") | ||
- Reference issues and pull requests | ||
- Keep first line under 72 characters | ||
- Describe what and why, not how | ||
|
||
## Review Process | ||
|
||
1. Automated checks must pass | ||
2. Code review by maintainers | ||
3. Documentation review | ||
4. Test coverage verification | ||
5. Final approval | ||
|
||
## Community | ||
|
||
- Join our [Discord server](https://discord.gg/your-invite) | ||
- Follow our [Twitter](https://twitter.com/your-handle) | ||
- Read our [blog](https://your-blog.com) | ||
|
||
## Recognition | ||
|
||
Contributors will be: | ||
|
||
- Listed in CONTRIBUTORS.md | ||
- Mentioned in release notes | ||
- Given special Discord roles | ||
|
||
Thank you for contributing! |
Oops, something went wrong.