Skip to content

Commit e4227b0

Browse files
committed
docs: add instructions to contribute to project
1 parent 9773704 commit e4227b0

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

CONTRIBUTING.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Contributing
2+
3+
This project accepts community contributions. In order to contribute, please:
4+
5+
1. Follow the coding style guidelines below
6+
2. Agree to the Developer Certificate of Origin
7+
3. Submit a GitHub pull request (PR) for review
8+
9+
## Coding Style
10+
11+
Please make sure to run [Black](https://black.readthedocs.io/en/stable/index.html)
12+
and [Flake8](https://flake8.pycqa.org/en/latest/) before submitting a PR.
13+
14+
## Developer Certificate of Origin
15+
16+
By contributing a PR to this project you agree to the [Developer Certificate of Origin (DCO)](https://developercertificate.org/).
17+
18+
In short, you agree that you can make the contribution and that the project has
19+
the right to distribute your contribution under the terms of the project's
20+
[LICENSE](LICENSE). The PR itself is a sign-off of your agreement to the DCO.
21+
22+
## Submission
23+
24+
Submit a PR against the `main` branch. Please include one of the following
25+
prefixes in your commit messages so the [CHANGELOG](CHANGELOG.md) can be updated
26+
automatically:
27+
28+
* `feat:` Adds a new feature
29+
* `fix:` Fixes a bug in the code
30+
* `refactor:` Restructures the code without changing its external behavior
31+
* `docs:` Documentation only changes
32+
* `test:` Adds or modifies tests
33+
* `style:` Changes to whitespace, formatting, etc; no code changes
34+
* `chore:` Changes to the build process or auxiliary tools

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -269,3 +269,9 @@ so these are not part of the official release.
269269

270270
The images are saved as PNGs in the `output` folder using the prompt text. The
271271
`build.sh` script creates and mounts this folder as a volume in the container.
272+
273+
## Contribution
274+
275+
See the [CONTRIBUTING.md](CONTRIBUTING.md) file for more details. In short,
276+
follow the style guidelines, agree to the Developer Certificate of Origin, and
277+
submit a PR.

0 commit comments

Comments
 (0)