Skip to content

Commit 626d17f

Browse files
committed
chore: add CONTRIBUTING & PULL_REQUEST_TEMPLATE
1 parent 5ceea07 commit 626d17f

2 files changed

Lines changed: 46 additions & 0 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
### What kind of change does this PR introduce?
2+
3+
> check at least one
4+
5+
- [ ] Bugfix
6+
- [ ] Feature
7+
- [ ] Refactor
8+
- [ ] Other, please describe:
9+
10+
### Validations
11+
12+
- [ ] Follow our [CONTRIBUTING](https://github.com/massCodeIO/massCode/blob/master/CONTRIBUTING) guide

CONTRIBUTING.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
Hey there! We are really excited that you are interested in contributing. Before submitting your contribution, please make sure to take a moment and read through the following guide:
2+
## Sending Pull Request
3+
4+
### Discuss First
5+
6+
Before you start to work on a feature pull request, it's always better to open a feature request issue first to [discuss](https://github.com/massCodeIO/massCode/discussions) with the maintainers whether the feature is desired and the design of those features. This would help save time for both the maintainers and the contributors and help features to be shipped faster.
7+
8+
For typo fixes, it's recommended to batch multiple typo fixes into one pull request to maintain a cleaner commit history.
9+
10+
### Commit Convention
11+
12+
We use [Conventional Commits](https://www.conventionalcommits.org/) for commit messages, which allows the changelog to be auto-generated based on the commits. Please read the guide through if you aren't familiar with it already.
13+
14+
Only `fix:` and `feat:` will be presented in the changelog.
15+
16+
Note that `fix:` and `feat:` are for actual code changes (that might affect logic). For typo or document changes, use docs: or chore: instead:
17+
18+
- ~~`fix: typo`~~ -> `docs: fix typo`
19+
20+
### Pull Request
21+
22+
If you don't know how to send a Pull Request, we recommend reading the [guide](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
23+
24+
When sending a pull request, make sure your PR's title also follows the Commit Convention.
25+
26+
If your PR fixes or resolves an existing issue, please add the following line in your PR description (replace 123 with a real issue number):
27+
28+
```
29+
fix #123
30+
```
31+
32+
It's ok to have multiple commits in a single PR, you don't need to rebase or force push for your changes as we will use Squash and Merge to squash the commits into one commit when merging.
33+
34+
And of course please test your code before PR.

0 commit comments

Comments
 (0)