Skip to content

Commit dbe08b8

Browse files
committed
Add contributing guide
1 parent 5408a97 commit dbe08b8

File tree

1 file changed

+89
-0
lines changed

1 file changed

+89
-0
lines changed

CONTRIBUTING.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# Contributing to poodle-python
2+
3+
We love your input! We want to make contributing to poodle-python as easy and transparent as possible, whether it's:
4+
5+
- Reporting a bug
6+
- Discussing the current state of the code
7+
- Submitting a fix
8+
- Proposing new features
9+
- Becoming a maintainer
10+
11+
## We Develop with GitHub
12+
13+
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
14+
15+
## We Use [Github Flow](https://docs.github.com/en/get-started/using-github/github-flow)
16+
17+
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
18+
19+
1. Fork the repo and create your branch from `main`.
20+
2. If you've added code that should be tested, add tests.
21+
3. If you've changed APIs, update the documentation.
22+
4. Ensure the test suite passes.
23+
5. Make sure your code lints.
24+
6. Issue that pull request!
25+
26+
## Development Process
27+
28+
1. Clone the repository:
29+
30+
```bash
31+
git clone https://github.com/usepoodle/poodle-python.git
32+
cd poodle-python
33+
```
34+
35+
2. Install dependencies using Poetry:
36+
37+
```bash
38+
poetry install
39+
```
40+
41+
3. Create a branch:
42+
43+
```bash
44+
git checkout -b feature/amazing-feature
45+
```
46+
47+
4. Make your changes and test them:
48+
49+
```bash
50+
poetry run pytest
51+
poetry run flake8
52+
```
53+
54+
5. Build the project to verify everything works:
55+
```bash
56+
poetry build
57+
```
58+
59+
## Any contributions you make will be under the MIT Software License
60+
61+
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
62+
63+
## Report bugs using GitHub's [issue tracker](https://github.com/usepoodle/poodle-python/issues)
64+
65+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/usepoodle/poodle-python/issues/new); it's that easy!
66+
67+
## Write bug reports with detail, background, and sample code
68+
69+
**Great Bug Reports** tend to have:
70+
71+
- A quick summary and/or background
72+
- Steps to reproduce
73+
- Be specific!
74+
- Give sample code if you can.
75+
- What you expected would happen
76+
- What actually happens
77+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
78+
79+
## Use a Consistent Coding Style
80+
81+
- Use Python for all new code.
82+
- Follow PEP 8 guidelines.
83+
- 4 spaces for indentation.
84+
- Run `poetry run black .` and `poetry run flake8` to automatically format and check code.
85+
- Write meaningful commit messages.
86+
87+
## License
88+
89+
By contributing, you agree that your contributions will be licensed under its MIT License.

0 commit comments

Comments
 (0)