Skip to content
This repository was archived by the owner on Sep 26, 2025. It is now read-only.

Commit 01eef18

Browse files
author
Mrinal Wahal
committed
updated docs
1 parent aaaa9c7 commit 01eef18

3 files changed

Lines changed: 4 additions & 49 deletions

File tree

CONDUCT.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,12 @@ There may be times, however, when canary is closed for breaking changes. This is
2323
Breaking changes are not allowed in release branches, as these represent minor versions that have already been released. These version have consumers who expect the APIs, behaviors, etc, to remain stable during the lifetime of the patch stream for the minor release.
2424

2525
Examples of breaking changes include:
26+
- Removing or modifying the base domain for all API calls.
2627
- Removing or modifying the behaviour of an API call, or a command.
2728

2829
Examples of minor changes include:
2930
- Removing or renaming exported constant, variable, type, or function.
30-
- Updating the version of critical libraries such as `spf13/pflag`, `spf13/viper` etc...
31+
- Updating the version of critical libraries such as `fsnotify/fsnotify`, `spf13/pflag` etc...
3132
- Some version updates may be acceptable for picking up bug fixes, but maintainers must exercise caution when reviewing.
3233

3334
There may, at times, need to be exceptions where breaking changes are allowed in release branches. These are at the discretion of the app's maintainers, and must be carefully considered before merging.

CONTRIBUTING.md

Lines changed: 0 additions & 46 deletions
This file was deleted.

contributing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ If you have questions regarding Nhost, feel free to ask it in the community
3030

3131
1. CLA: All Pull Requests (PRs) will be subjected to rigourous testing by the maintainers and the maintainers hold ultimate rights to approve or reject a PR merge.
3232
1. Tests: If you are submitting code, please ensure you have adequate tests
33-
for the feature. Tests can be run via `go test ./...` or `make test`.
33+
for the feature. Tests can be run via `go test ./...`.
3434
1. Since this is golang project, ensure the new code is properly formatted to
35-
ensure code consistency. Run `make all`.
35+
ensure code consistency. Run `go build`.
3636

3737
### Quick steps to contribute
3838

0 commit comments

Comments
 (0)