Skip to content

Commit

Permalink
docs(contributing): add contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Fdawgs committed Nov 2, 2023
1 parent 29329a1 commit 1606f4b
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 0 deletions.
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Contributing

Contributions are welcome and any help that can be offered is greatly appreciated.
Please take a moment to read the entire contributing guide.

This repository uses the [Feature Branch Workflow](https://atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow),
meaning that development should take place in `feat/` branches, with the `main` branch kept in a stable state.
When you submit pull requests, please make sure to fork from and submit back to `main`.

Other processes and specifications that are in use in this repository are:

- [Semantic versioning](https://semver.org/)
- [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)

## Documentation style

Documentation (both in markdown files and inline comments) should be written in **American English** where possible.

Titles and headings should use sentence-style capitalization, where only the first letter of a sentence and proper nouns are capitalized.

## Release process

To create a release, run the [`release` workflow](https://github.com/fastify/workflows/actions/workflows/release.yml) by clicking the "Run workflow" button,
and entering the release type (major, minor, or patch) into the presented input field.

This will create a new branch and a pull request to `main` with the changes required to bump the version number.

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).

## Issues

Please file your issues [here](https://github.com/fastify/workflows/issues) and try to provide as much information in the template as possible/relevant.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,13 @@ Past sponsors:

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

## Contributing

Contributions are welcome, and any help is greatly appreciated!

See [the contributing guide](./CONTRIBUTING.md) for details on how to get started.
Please adhere to Fastify's [Code of Conduct](https://github.com/fastify/.github/blob/main/CODE_OF_CONDUCT.md) when contributing.

## License

Licensed under [MIT](./LICENSE).

0 comments on commit 1606f4b

Please sign in to comment.