Skip to content

Commit 1606f4b

Browse files
committed
docs(contributing): add contributing guide
1 parent 29329a1 commit 1606f4b

File tree

2 files changed

+39
-0
lines changed

2 files changed

+39
-0
lines changed

CONTRIBUTING.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Contributing
2+
3+
Contributions are welcome and any help that can be offered is greatly appreciated.
4+
Please take a moment to read the entire contributing guide.
5+
6+
This repository uses the [Feature Branch Workflow](https://atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow),
7+
meaning that development should take place in `feat/` branches, with the `main` branch kept in a stable state.
8+
When you submit pull requests, please make sure to fork from and submit back to `main`.
9+
10+
Other processes and specifications that are in use in this repository are:
11+
12+
- [Semantic versioning](https://semver.org/)
13+
- [Conventional commits](https://conventionalcommits.org/en/v1.0.0/) following the [@commitlint/config-conventional config](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional)
14+
15+
## Documentation style
16+
17+
Documentation (both in markdown files and inline comments) should be written in **American English** where possible.
18+
19+
Titles and headings should use sentence-style capitalization, where only the first letter of a sentence and proper nouns are capitalized.
20+
21+
## Release process
22+
23+
To create a release, run the [`release` workflow](https://github.com/fastify/workflows/actions/workflows/release.yml) by clicking the "Run workflow" button,
24+
and entering the release type (major, minor, or patch) into the presented input field.
25+
26+
This will create a new branch and a pull request to `main` with the changes required to bump the version number.
27+
28+
This method should be used for all releases as it also rebases tags. For example, if you release `v4.0.1` then the `v4` and `v4.0` tags are automatically updated to the new commit (or created if they don't exist).
29+
30+
## Issues
31+
32+
Please file your issues [here](https://github.com/fastify/workflows/issues) and try to provide as much information in the template as possible/relevant.

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,13 @@ Past sponsors:
120120

121121
- [Yeovil District Hospital NHS Foundation Trust](https://yeovilhospital.co.uk/)
122122

123+
## Contributing
124+
125+
Contributions are welcome, and any help is greatly appreciated!
126+
127+
See [the contributing guide](./CONTRIBUTING.md) for details on how to get started.
128+
Please adhere to Fastify's [Code of Conduct](https://github.com/fastify/.github/blob/main/CODE_OF_CONDUCT.md) when contributing.
129+
123130
## License
124131

125132
Licensed under [MIT](./LICENSE).

0 commit comments

Comments
 (0)