Skip to content

Commit d726114

Browse files
Add contributing guidelines to CONTRIBUTING.md (#79)
* Add contributing guidelines to CONTRIBUTING.md Added contributing guidelines for the Agent365-python project, including sections on code of conduct, how to contribute, development process, and licensing. * Update CONTRIBUTING.md Co-authored-by: Johan Broberg <johan@pontemonti.net> * Update CONTRIBUTING.md Co-authored-by: Johan Broberg <johan@pontemonti.net> --------- Co-authored-by: Johan Broberg <johan@pontemonti.net>
1 parent a33e81a commit d726114

1 file changed

Lines changed: 58 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Contributing to Agent365-python
2+
3+
First off, thank you for taking the time to contribute! 🎉
4+
5+
We welcome contributions from everyone, whether you're fixing bugs, adding new features, or improving documentation. Here are a few guidelines to help you get started.
6+
7+
## Table of Contents
8+
- [Code of Conduct](#code-of-conduct)
9+
- [How to Contribute](#how-to-contribute)
10+
- [Reporting Bugs](#reporting-bugs)
11+
- [Suggesting Enhancements](#suggesting-enhancements)
12+
- [Submitting Code Changes](#submitting-code-changes)
13+
- [Development Process](#development-process)
14+
- [License](#license)
15+
16+
## Code of Conduct
17+
18+
By participating in this project, you agree to abide by the [Code of Conduct](CODE_OF_CONDUCT.md). Please be respectful and considerate to others, as we want to foster a friendly and inclusive community.
19+
20+
## How to Contribute
21+
22+
We appreciate any help! There are several ways you can contribute to this project:
23+
24+
### Reporting Bugs
25+
- If you find a bug, please check if it has already been reported. If not, open a new issue with a clear description of the problem and how to reproduce it.
26+
- Provide any relevant information like logs, steps to reproduce, or screenshots to help us understand the issue better.
27+
28+
### Suggesting Enhancements
29+
- If you have an idea for a new feature or improvement, please open an issue to discuss it first. This allows us to prioritize the feature and make sure it fits with the project vision.
30+
- Clearly describe the idea and its potential impact.
31+
32+
### Submitting Code Changes
33+
- Fork the repository and create a new branch for your feature or bugfix.
34+
- Write clear, descriptive commit messages.
35+
- Follow the coding style used in the project (indentation, variable names, etc.).
36+
- If applicable, add tests that ensure your changes work as expected.
37+
- Submit a pull request with a description of what you've done and why.
38+
- Make sure your changes pass any automated checks or tests (e.g., CI/CD pipeline).
39+
40+
## Development Process
41+
42+
1. Fork the repository and clone it to your local machine.
43+
2. Create a new branch for your changes.
44+
3. Make the necessary changes and ensure the project works as expected.
45+
4. Commit your changes and push them to your fork.
46+
5. Open a pull request. Make sure to include a detailed description of what you've changed and why.
47+
48+
### Code Reviews
49+
- After you submit a pull request, the maintainers will review it. If they have any questions or requests for changes, they will provide feedback.
50+
- Address the feedback and make any necessary changes before the pull request is merged.
51+
52+
## License
53+
54+
By contributing to this project, you agree that your contributions will be licensed under the same license as the project. See [LICENSE](LICENSE.md) for more details.
55+
56+
---
57+
58+
Thank you for contributing! 🎉 We appreciate your help in making this project better.

0 commit comments

Comments
 (0)