diff options
| author | Barichello <artur@barichello.me> | 2022-01-17 00:04:43 -0300 |
|---|---|---|
| committer | Barichello <artur@barichello.me> | 2022-01-17 00:05:00 -0300 |
| commit | fea149bcf01d517920f40e4b8a1bdac017e3c60c (patch) | |
| tree | 2ee847dbffc6f1139bf963917ab340425f86a182 | |
| parent | 0ccf9289b53a6a954dc26c86e37e768f83253577 (diff) | |
| download | NorthstarWiki-fea149bcf01d517920f40e4b8a1bdac017e3c60c.tar.gz NorthstarWiki-fea149bcf01d517920f40e4b8a1bdac017e3c60c.zip | |
Update contributing section
Transforming the contributing section to include the entire northstar project, not just the wiki part
| -rw-r--r-- | docs/README.md | 6 | ||||
| -rw-r--r-- | docs/contributing.md | 17 | ||||
| -rw-r--r-- | docs/development.md | 2 |
3 files changed, 9 insertions, 16 deletions
diff --git a/docs/README.md b/docs/README.md index dec8946..280edc2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -31,12 +31,10 @@ For modding guides, documentation on Northstar API features and documentation on ## Contact and contributing **Please remember:** You should expect to encounter bugs and crashes with Northstar.\ -Northstar is mostly being developed by a single person as a mod to Titanfall|2.\ -If you do encounter issues that this guide doesn't have a fix for, you can get support in the Discord linked below. - +If you need help troubleshooting, setting up or modifying Northstar try talking to the community on our Discord server: {% embed url="https://northstar.tf/discord" %} -For contributing check: +Before creating issues or contributing changes to the source code please read: {% content-ref url="contributing.md" %} [contributing.md](contributing.md) diff --git a/docs/contributing.md b/docs/contributing.md index 5af6289..3314b1b 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,18 +1,15 @@ --- -description: Want to contribute, question, contact, or need help? +description: Contribution guidelines --- # Contributing -### Contributing <a href="#contributing" id="contributing"></a> +### Creating an issue <a href="#contributing" id="contributing"></a> -In case you feel like something is out of place, not accurate, biased, or if you just want to contribute, please [open a new issue](https://github.com/R2Northstar/NorthstarWiki/issues/) or [make a pull request](https://github.com/R2Northstar/NorthstarWiki/pulls) to our wiki:\ -[https://github.com/R2Northstar/NorthstarWiki](https://github.com/R2Northstar/NorthstarWiki) +Read [CONTRIBUTING.md](https://github.com/R2Northstar/Northstar/blob/main/CONTRIBUTING.md) before creating an issue, if you believe that the issue is valid fill the provided template with the requested info. -### Contacting us +{% hint style="info" %} +Please remember that issues created in the Northstar repositories should be related to the mod, avoid creating issues asking for tech support or problems unrelated to the project. +{% endhint %} -You are welcome to create an issue at:\ -[https://github.com/R2Northstar/NorthstarWiki/issues](https://github.com/R2Northstar/NorthstarWiki/issues) - -Alternatively feel free to reach out via Discord:\ -[https://northstar.tf/discord](https://northstar.tf/discord) +Check the [Development](development.md) section if you are unsure of where to open a ticket. diff --git a/docs/development.md b/docs/development.md index d931803..a9b541b 100644 --- a/docs/development.md +++ b/docs/development.md @@ -21,8 +21,6 @@ Northstar is split over multiple git repositories that fulfil different function * [NorthstarWiki](https://github.com/R2Northstar/NorthstarWiki):\ The repository for this wiki. - - ### Setup Build instructions for the launcher can be found here: |