Skip to content

Commit bdb57e0

Browse files
committed
chore: add contribution guide
1 parent ed80fbe commit bdb57e0

File tree

1 file changed

+84
-0
lines changed

1 file changed

+84
-0
lines changed

CONTRIBUTING.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Contributing to Roach
2+
3+
This is the Contribution Guide for Roach PHP. Please read this document
4+
carefully before opening an issue or a pull request.
5+
6+
## Code of Conduct
7+
8+
Before contributing to the project, please read our
9+
[Code of Conduct](./CODE_OF_CONDUCT.md).
10+
11+
## Reporting a bug
12+
13+
Before you submit an issue, please search [the issue tracker][issues]. An issue
14+
for your problem might already exist and the discussion might inform you of
15+
workarounds readily available.
16+
17+
You can file new issues by [selecting an issue template][new-issue] and filling
18+
out the necessary information.
19+
20+
## Proposing a Change
21+
22+
If you intend to change the public API or make any non-trivial changes to the
23+
implementation, make sure to [create an issue][new-feature] first. This will let
24+
us discuss a proposal before you put significant effort into it.
25+
26+
If you're only fixing a bug or a typo, it's fine to submit a pull request right
27+
away without creating an issue, but make sure it contains a clear and concise
28+
description of the bug.
29+
30+
## Working on Issues
31+
32+
Before you start working on an issue make sure that it has been accepted
33+
(indicated by an [`accepted`][label-accepted] label) and that no one has
34+
claimed it yet. Otherwise, you may duplicate other people's efforts. If somebody
35+
claims an issue but doesn't follow up for more than two weeks, it’s fine to take
36+
it over, but you should still leave a comment. You should also leave a comment
37+
on any issue you're working on, to let others know.
38+
39+
## Semantic Versioning
40+
41+
Roach follows [semantic versioning][semver].
42+
43+
## Making a Pull Request
44+
45+
1. Fork the roach-php/core repo.
46+
2. In your forked repo, create a new branch for your changes:
47+
```shell
48+
git checkout -b my-fix-branch main
49+
```
50+
3. Update the code.
51+
4. Commit your changes using a **descriptive commit message** that follows the
52+
[Angular Commit Message Conventions][commit-format].
53+
```shell
54+
git commit --all
55+
```
56+
5. Push your branch to GitHub:
57+
```shell
58+
git push origin my-fix-branch
59+
```
60+
6. In GitHub, send a pull request to [the main branch][main].
61+
62+
### Addressing review feedback
63+
64+
1. Make required updates to the code.
65+
2. Create a fixup commit and push it to your GitHub repo:
66+
```shell
67+
git commit --all --fixup HEAD
68+
git push
69+
```
70+
71+
## Attribution
72+
73+
This Contribution Guide was adapted from the [Motion Canvas][motion-canvas]
74+
Contribution guide
75+
76+
[semver]: https://semver.org/
77+
[semantic-release]: https://semantic-release.gitbook.io/semantic-release/support/faq#can-i-set-the-initial-release-version-of-my-package-to-0.0.1
78+
[main]: https://github.com/roach-php/core/tree/main
79+
[issues]: https://github.com/roach-php/core/issues
80+
[new-issue]: https://github.com/roach-php/core/issues/new/choose
81+
[new-feature]: https://github.com/roach-php/core/issues/new?template=feature_request.md
82+
[commit-format]: https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit
83+
[motion-canvas]: https://github.com/motion-canvas/motion-canvas/blob/main/CONTRIBUTING.md
84+
[label-accepted]: https://github.com/roach-php/core/labels/accepted

0 commit comments

Comments
 (0)