Skip to content

Commit 70f0987

Browse files
committed
add contributing section in README, partially resolves #2
1 parent d5d53b3 commit 70f0987

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,3 +80,34 @@ Alibaba:
8080
- <https://www.alibabacloud.com/help/doc-detail/51374.htm>
8181

8282
All timestamps MUST be formatted according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6).
83+
84+
## Contributing
85+
86+
All contributions are subject to the
87+
[STAC Specification Code of Conduct](https://github.com/radiantearth/stac-spec/blob/master/CODE_OF_CONDUCT.md).
88+
For contributions, please follow the
89+
[STAC specification contributing guide](https://github.com/radiantearth/stac-spec/blob/master/CONTRIBUTING.md) Instructions
90+
for running tests are copied here for convenience.
91+
92+
### Running tests
93+
94+
The same checks that run as checks on PR's are part of the repository and can be run locally to verify that changes are valid.
95+
To run tests locally, you'll need `npm`, which is a standard part of any [node.js installation](https://nodejs.org/en/download/).
96+
97+
First you'll need to install everything with npm once. Just navigate to the root of this repository and on
98+
your command line run:
99+
```bash
100+
npm install
101+
```
102+
103+
Then to check markdown formatting and test the examples against the JSON schema, you can run:
104+
```bash
105+
npm test
106+
```
107+
108+
This will spit out the same texts that you see online, and you can then go and fix your markdown or examples.
109+
110+
If the tests reveal formatting problems with the examples, you can fix them with:
111+
```bash
112+
npm run format-examples
113+
```

0 commit comments

Comments
 (0)