Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update CONTRIBUTING.md #2280

Merged
merged 4 commits into from
May 10, 2024
Merged

docs: update CONTRIBUTING.md #2280

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
be64653
docs: update CONTRIBUTING.md
maschad May 9, 2024
cd80632
update changeset
maschad May 9, 2024
1290671
docs: add notes about semantic versioning
maschad May 9, 2024
df53a5f
Merge branch 'master' into mc/docs/update-contributing
petertonysmith94 May 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions .changeset/dirty-jokes-pump.md
View file
Open in desktop
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
View file
Open in desktop
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