Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jwsi committed Jul 30, 2020
1 parent bf034ce commit 3718073
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,17 @@ Our development team aim to respond within two days.

We track issues using multiple tags and each one has a specific meaning in relation to an issue you file and it's important you understand what each one means so that you can understand how your issue is being handled. Please see this [list](https://github.com/ultrahorizon/UH-VPN-Docs/labels) for descriptions of all of our tags.

## Contributions

To contribute to UH VPN Docs, please do the following:

1. Create an issue in UH VPN Docs and assign yourself to it.
2. Fork this repo.
3. Make your changes on feature branch within your newly forked repo.
4. Create a PR within this repo proposing a merge from your personal feature branch into the master branch on this repository.
5. Link the issue from the PR by including the text `Resolves #num` where `num` is the appropriate issue number.
6. Request a review from a moderator.

## Building the docs locally

- Clone the repo:
Expand All @@ -44,14 +55,3 @@ pip install -r requirements.txt
```bash
make html
```

## Contributions

To contribute to UH VPN Docs, please do the following:

1. Create an issue in UH VPN Docs and assign yourself to it.
2. Fork this repo.
3. Make your changes on feature branch within your newly forked repo.
4. Create a PR within this repo proposing a merge from your personal feature branch into the master branch on this repository.
5. Within the PR, link the issue by including the text `Resolves #num` where `num` is the appropriate issue number.
6. Request a review from a moderator.

0 comments on commit 3718073

Please sign in to comment.