-
Notifications
You must be signed in to change notification settings - Fork 162
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f65e93d
commit 9590ae3
Showing
1 changed file
with
10 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,21 @@ | ||
| --- | ||
| title: Contributing | ||
| title: Contributing to Auspice | ||
| --- | ||
|
|
||
|
|
||
| Auspice is developed via GitHub and issues and comments are very welcome. | ||
| Auspice is developed via GitHub and issues and comments are very welcome -- [click here](https://github.com/nextstrain/auspice/issues/new) to create a new issue. | ||
| Alternatively, you can [email us](mailto:[email protected]) with any questions or comments you may have. | ||
|
|
||
|
|
||
| ## Contributing to tbe Docs | ||
| ## Contributing to Documentation | ||
|
|
||
| This documentation is all contained within the Auspice GitHub repo -- see [the docs-src directory](https://github.com/nextstrain/auspice/tree/master/docs-src) for more details and instructions on how to contribute. | ||
| This documentation is all contained within the Auspice GitHub repo -- see [the README](https://github.com/nextstrain/auspice/tree/master/docs-src) within the `docs-src` directory for more details and instructions on how to contribute. | ||
|
|
||
| ## Contributing to Devlopment | ||
| If you are interested in contrubuting code then we would recommend that you create a [GitHub issue](https://github.com/nextstrain/auspice/issues) before spending time in the codebase. | ||
|
|
||
| ## Contributing to Development | ||
|
|
||
| We're very happy to have outside contributions to Auspice and see it grow. | ||
| If you are interested in contrubuting code then we would recommend that you create a [GitHub issue](https://github.com/nextstrain/auspice/issues/new) before spending time in the codebase. | ||
| For pull requests, please use [eslint](https://eslint.org/) as much as possible -- thanks! | ||
|
|
||
|
|
||
|
|
@@ -22,4 +25,5 @@ For pull requests, please use [eslint](https://eslint.org/) as much as possible | |
| New versions are released via the `./releaseNewVersion.sh` script from an up-to-date `master` branch. | ||
|
|
||
| It will prompt you for the version number increase, push changes to the `release` branch and, as long as Travis-CI is successful, then a new version will be automatically published to [npm](https://www.npmjs.com/package/auspice). | ||
| > Note that for this to work, you will need to have push access to the [auspice](https://github.com/nextstrain/auspice/) repository. | ||