You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 8, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+13-11Lines changed: 13 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,23 +16,17 @@ The following is a set of guidelines for contributing to PayID and associated pa
16
16
17
17
## Code of Conduct
18
18
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).
22
20
23
21
## Issue Reporting Guidelines
24
22
25
-
<!-- TODO:(hbergren) Update these links when we migrate to `payid-org`. -->
26
-
27
23
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.
28
24
29
25
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.
30
26
31
27
### Reporting Vulnerabilities
32
28
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.
36
30
37
31
## Pull Request Guidelines
38
32
@@ -53,7 +47,6 @@ If you have found a vulnerability, please read our [Vulnerability Disclosure Pol
53
47
54
48
## Versioning
55
49
56
-
<!-- TODO:(hbergren) Update the Github Releases link to `payid-org` when it exists -->
57
50
<!-- TODO:(hbergren) Add a link to the CHANGELOG when it exists. -->
58
51
59
52
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
64
57
65
58
## Development Setup
66
59
67
-
<!-- TODO:(hbergren) We should update this section once we have our Postgres Docker container. -->
68
-
69
60
You will need [NodeJS](https://nodejs.org/en/) v12 or higher, and [npm](https://www.npmjs.com/get-npm).
70
61
71
62
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
87
78
88
79
# Lint the code, auto-fixing any auto-fixable problems
89
80
$ 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
90
92
```
91
93
92
94
There are other scripts available in the `scripts` section of the [package.json](./package.json) file.
0 commit comments