Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Mrinal Wahal committed Oct 22, 2021
1 parent aaaa9c7 commit 01eef18
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 49 deletions.
3 changes: 2 additions & 1 deletion CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,12 @@ There may be times, however, when canary is closed for breaking changes. This is
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.

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

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

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.
Expand Down
46 changes: 0 additions & 46 deletions CONTRIBUTING.md

This file was deleted.

4 changes: 2 additions & 2 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ If you have questions regarding Nhost, feel free to ask it in the community

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.
1. Tests: If you are submitting code, please ensure you have adequate tests
for the feature. Tests can be run via `go test ./...` or `make test`.
for the feature. Tests can be run via `go test ./...`.
1. Since this is golang project, ensure the new code is properly formatted to
ensure code consistency. Run `make all`.
ensure code consistency. Run `go build`.

### Quick steps to contribute

Expand Down

0 comments on commit 01eef18

Please sign in to comment.