Skip to content
This repository was archived by the owner on Mar 8, 2024. It is now read-only.

Commit 221c192

Browse files
docs: update contributing (#528)
1 parent e5c1a26 commit 221c192

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,17 @@ The following is a set of guidelines for contributing to PayID and associated pa
1616

1717
## Code of Conduct
1818

19-
<!-- TODO:(hbergren) Update this to the Code of Conduct on `payid-org` when it exists -->
20-
21-
This project and all participants are governed by the [PayID Code of Conduct](https://github.com/xpring-eng/.github/blob/master/CODE_OF_CONDUCT.md).
19+
This project and all participants are governed by the [PayID Code of Conduct](https://github.com/payid-org/guidelines/blob/master/CODE_OF_CONDUCT.md).
2220

2321
## Issue Reporting Guidelines
2422

25-
<!-- TODO:(hbergren) Update these links when we migrate to `payid-org`. -->
26-
2723
If you've found a bug or want to request a new feature, please [create a new issue](https://github.com/payid-org/payid/issues/new) or a [pull request](https://github.com/payid-org/payid/compare) on GitHub.
2824

2925
Please include as much detail as possible to help us properly address your issue. If we need to triage issues and constantly ask people for more detail, that's time taken away from actually fixing issues. Help us be as efficient as possible by including a lot of detail in your issues.
3026

3127
### Reporting Vulnerabilities
3228

33-
<!-- TODO:(hbergren) Update this link when we migrate to `payid-org` -->
34-
35-
If you have found a vulnerability, please read our [Vulnerability Disclosure Policy](https://github.com/xpring-eng/.github/blob/master/SECURITY.md) to learn how to responsibly report the vulnerability.
29+
If you have found a vulnerability, please read our [Vulnerability Disclosure Policy](https://github.com/payid-org/guidelines/blob/master/SECURITY.md) to learn how to responsibly report the vulnerability.
3630

3731
## Pull Request Guidelines
3832

@@ -53,7 +47,6 @@ If you have found a vulnerability, please read our [Vulnerability Disclosure Pol
5347

5448
## Versioning
5549

56-
<!-- TODO:(hbergren) Update the Github Releases link to `payid-org` when it exists -->
5750
<!-- TODO:(hbergren) Add a link to the CHANGELOG when it exists. -->
5851

5952
The PayID reference implementation itself follows [Semantic Versioning](https://semver.org/), and this is the version that is referenced by [Github Releases](https://github.com/payid-org/payid/releases) and in the [package.json](./package.json) file.
@@ -64,8 +57,6 @@ The RESTful CRUD API for interacting with PayIDs on the server is versioned as w
6457

6558
## Development Setup
6659

67-
<!-- TODO:(hbergren) We should update this section once we have our Postgres Docker container. -->
68-
6960
You will need [NodeJS](https://nodejs.org/en/) v12 or higher, and [npm](https://www.npmjs.com/get-npm).
7061

7162
You will also need a local Postgres database running. The specifics can be set as environment variables read in [config.ts](./src/config.ts).
@@ -87,6 +78,17 @@ $ npm run test
8778

8879
# Lint the code, auto-fixing any auto-fixable problems
8980
$ npm run lint
81+
82+
# Boot up a development database
83+
# (A Postgres database in a Docker container configured to run with PayID)
84+
$ npm run devDbUp
85+
86+
# Boot up a full development environment
87+
# (A database & PayID server in 2 separate Docker containers)
88+
$ npm run devEnvUp
89+
90+
# Bring down the development environment
91+
$ npm run devDown
9092
```
9193

9294
There are other scripts available in the `scripts` section of the [package.json](./package.json) file.

0 commit comments

Comments
 (0)