Skip to content

Commit

Permalink
docs: update CONTRIBUTING.md (#2280)
Browse files Browse the repository at this point in the history
* docs: update CONTRIBUTING.md

* update changeset

* docs: add notes about semantic versioning

---------

Co-authored-by: Peter Smith <peter@blueoceancomputing.co.uk>
  • Loading branch information
maschad and petertonysmith94 committed May 10, 2024
1 parent 28e5f06 commit fdca46a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
4 changes: 4 additions & 0 deletions .changeset/dirty-jokes-pump.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
---

docs: update `CONTRIBUTING.md`
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ the following categories:

1. Fork the fuels-ts repository and clone your fork

2. Create a new branch out of the `master` branch.
2. Create a new branch out of the `master` branch with the naming convention `<username>/<fix|feat|chore|build|docs>/<branch-name>`.

3. Make and commit your changes following the
[commit convention](https://github.com/FuelLabs/fuels-ts/blob/master/README.md#commit-convention).
Expand All @@ -200,6 +200,8 @@ the following categories:
Please note that you might have to run `git fetch origin master` (where
origin will be your fork on GitHub) before `pnpm changeset` works.

5. We adhere to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for semantic versioning, and given that we currently do not have a major release yet, only breaking changes would require a `minor` version bump. All other API compatible changes would be a `patch` version bump.

> If you made minor changes like CI config, prettier, etc, you can run
> `pnpm changeset add --empty` to generate an empty changeset file to document
> your changes.
Expand Down

0 comments on commit fdca46a

Please sign in to comment.