Skip to content

Commit 7db7847

Browse files
committed
Begin contribution guide
1 parent 9966998 commit 7db7847

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
[`Node.js`](https://nodejs.org/en/download)
2+
3+
# Contributing to the Guide
4+
5+
> [!NOTE]
6+
> This page is in the process of being written, and will largely be
7+
> adapted from [PlasmaPy's Contributor Guide].
8+
9+
## Submitting a pull request
10+
11+
A contribution to this guide can be made via a pull request to the
12+
repository's `main` branch.
13+
14+
## Building the site locally
15+
16+
> [!NOTE]
17+
> It may be necessary to install a recent version of [`Node.js`].
18+
19+
After cloning the repository, go to the top-level directory and run
20+
21+
```bash
22+
python noxfile.py -s build
23+
```
24+
25+
The build will be located at `_build/html/index.html`.
26+
27+
[PlasmaPy's Contributor Guide]: https://docs.plasmapy.org/en/latest/contributing

0 commit comments

Comments
 (0)