jimmy/postgrest
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update contributing guidelines

Browse Source
This commit is contained in:
Wolfgang Walther
2021-04-06 17:07:14 +02:00
committed by Wolfgang Walther
parent 65e7f9e846
commit 376beac22f
1 changed files with 11 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/CONTRIBUTING.md
+11 -13
View File
@@ -15,14 +15,14 @@ your contributions.
## Issues ## Issues
For questions on how to use PostgREST, please use
[GitHub discussions](https://github.com/PostgREST/postgrest/discussions).
### Reporting an Issue ### Reporting an Issue
* Make sure you test against the latest released version. It is possible * Make sure you test against the latest [stable release](https://github.com/PostgREST/postgrest/releases/latest)
we already fixed the bug you're experiencing. and also against the latest [nightly release](https://github.com/PostgREST/postgrest/releases/tag/nightly).
It is possible we already fixed the bug you're experiencing.
* Also check the `CHANGELOG.md` to see if any unreleased changes affect
the issue. The very newest changes can take a little while to be released
as a new official version.
* Provide steps to reproduce the issue, including your OS version and * Provide steps to reproduce the issue, including your OS version and
the specific database schema that you are using. the specific database schema that you are using.
@@ -32,11 +32,14 @@ your contributions.
then [find your logs](http://blog.endpoint.com/2014/11/dear-postgresql-where-are-my-logs.html). then [find your logs](http://blog.endpoint.com/2014/11/dear-postgresql-where-are-my-logs.html).
* If your database schema has changed while the PostgREST server is running, * If your database schema has changed while the PostgREST server is running,
[send the server a `SIGUSR1` signal](http://postgrest.org/en/stable/admin.html#schema-reloading) or restart it to ensure the schema cache [send the server a `SIGUSR1` signal](http://postgrest.org/en/latest/admin.html#schema-reloading) or restart it to ensure the schema cache
is not stale. This sometimes fixes apparent bugs. is not stale. This sometimes fixes apparent bugs.
## Code ## Code
We have a fully nix-based development environment with many tools for a smooth development workflow available.
Check the [development docs](https://github.com/PostgREST/postgrest/blob/main/nix/README.md) on how to set it up and use it.
### Haskell Conventions ### Haskell Conventions
* All contributions must pass the tests before being merged. When * All contributions must pass the tests before being merged. When
@@ -47,11 +50,6 @@ your contributions.
pull request. There are useful tools in the nix-shell that help with checking this locally. You can run `postgrest-check` to do this manually but pull request. There are useful tools in the nix-shell that help with checking this locally. You can run `postgrest-check` to do this manually but
we recommend adding it to `.git/hooks/pre-commit` as `nix-shell --run postgrest-check` to automatically check this before doing a commit. we recommend adding it to `.git/hooks/pre-commit` as `nix-shell --run postgrest-check` to automatically check this before doing a commit.
* For help building the Haskell code on your computer check out the [building from
source](https://postgrest.org/en/stable/development.html#build-from-source) docs section.
### Running Tests ### Running Tests
For instructions on running tests, see the official docs hosted here: For instructions on running tests, see the [development docs](https://github.com/PostgREST/postgrest/blob/main/nix/README.md#testing).
https://postgrest.org/en/stable/development.html#running-the-test-suite