Skip to content

Commit

Permalink
readme: Update contribution instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
tuxuser committed Oct 2, 2023
1 parent d4292e2 commit d8780b7
Showing 1 changed file with 4 additions and 8 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,11 @@ Contributions are very welcome. Here's how you can help:

1. __Fork__ this repo
1. Make changes
1. __Verify__ your changes are formatted properly
1. __Verify__ your changes are formatted properly (otherwise the PR cannot be accepted)
1. Send a __Pull Request__

**NOTE**: When adding a new page, ensure it's linked in [NAVIGATION.md](./docs/NAVIGATION.md)

## Local testing

1. Clone your fork of the wiki (**Change 'yourusername' accordingly**)
Expand Down Expand Up @@ -74,10 +76,4 @@ docker compose up
```

2. Navigate to <http://127.0.0.1:8000>
3. Make your changes

## Submit your work

- Commit your changes
- Push the changes
- Send a Pull Request
3. Make your changes and verify the formatting / linking still checks out

0 comments on commit d8780b7

Please sign in to comment.