Skip to content

Commit d17793a

Browse files
committed
chore: add OSS related docs
1 parent d622857 commit d17793a

5 files changed

Lines changed: 94 additions & 30 deletions

File tree

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @grega

.github/ISSUE_TEMPLATE.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## Summary
2+
3+
Describe the issue.
4+
5+
## Steps to reproduce
6+
7+
1.
8+
2.
9+
3.
10+
11+
## Expected behaviour
12+
13+
Describe what you expected to happen.
14+
15+
## Actual behaviour
16+
17+
Describe what happened instead.
18+
19+
## Environment
20+
21+
- Runtime:
22+
- Browser or platform:
23+
- Package version:
24+
25+
## Additional context
26+
27+
Add any other useful details, screenshots, or example code.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Summary
2+
3+
Describe the change.
4+
5+
## Testing
6+
7+
- [ ] `npm test`
8+
- [ ] Additional manual testing completed
9+
10+
## Checklist
11+
12+
- [ ] Linked relevant issue, if applicable
13+
- [ ] Updated tests, if needed
14+
- [ ] Updated docs, if needed

CONTRIBUTING.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Contributing
2+
3+
## Prerequisites
4+
5+
- **asdf** for environment management
6+
- **Node.js** (installed via asdf)
7+
- **npm** (bundled with Node)
8+
9+
## Development setup
10+
11+
Follow the guide at [asdf-vm.com](https://asdf-vm.com/).
12+
13+
Then install the Node.js plugin:
14+
15+
```bash
16+
asdf plugin add nodejs
17+
asdf install
18+
```
19+
20+
This will read `.tool-versions` and install the appropriate version of Node.js automatically.
21+
22+
```bash
23+
npm install
24+
npm run build -- --watch
25+
```
26+
27+
## Tests
28+
29+
```bash
30+
npm test
31+
```
32+
33+
To continuously watch for file changes:
34+
35+
```bash
36+
npm run dev:test
37+
```
38+
39+
## Pull requests
40+
41+
- Keep changes focused and small where possible.
42+
- Add or update tests when behaviour changes.
43+
- Update documentation when public APIs or workflows change.
44+
- Make sure tests pass before opening a pull request.
45+
46+
## Reporting issues
47+
48+
When reporting a bug, include the Python code, the runtime you used, the error you received, and the behaviour you expected.

README.md

Lines changed: 4 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -48,43 +48,17 @@ See the [demo](docs/README.md) for a full set of examples.
4848

4949
## Development
5050

51-
### Prerequisites
51+
See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed instructions.
5252

53-
- **asdf** for environment management
54-
- **Node.js** (installed via asdf)
55-
- **npm** (bundled with Node)
56-
57-
### Set up
58-
59-
Follow the guide at [asdf-vm.com](https://asdf-vm.com/).
60-
61-
Then install the Node.js plugin:
53+
In brief:
6254

6355
```bash
64-
asdf plugin add nodejs
65-
asdf install
66-
```
67-
68-
This will read `.tool-versions` and install the appropriate version of Node.js automatically.
69-
70-
```
7156
npm install
7257
npm run build -- --watch
73-
```
74-
75-
### Tests
76-
77-
```
7858
npm test
7959
```
8060

81-
To continuously watch for file changes:
82-
83-
```
84-
npm run dev:test
85-
```
86-
87-
### Building
61+
## Building
8862

8963
Create a clean build for distribution:
9064

@@ -98,7 +72,7 @@ You can now import, and use it, elsewhere (see Usage notes).
9872

9973
The package is published to: https://github.com/RaspberryPiFoundation/python-friendly-error-messages/pkgs/npm/python-friendly-error-messages
10074

101-
### Publishing
75+
## Publishing
10276

10377
```bash
10478
npm publish

0 commit comments

Comments
 (0)