github
/
Northstar
mirror of https://github.com/R2Northstar/Northstar
1
Fork 0
Code Releases Activity

[docs] adding CONTRIBUTING document skeleton

This commit is contained in:
Alystrasz 2021-12-26 12:48:01 +01:00 committed by Barichello
parent 57397bdac3
commit 541dbd3595
1 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,28 @@
# Welcome to Northstar contribution guide
Thank you for investing your time in contributing to our project!
## Repositories architecture
Northstar software is splitted into several repositories:
* [Northstar](https://github.com/R2Northstar/Northstar) is the main repository; it only contains downloadable
versions of the client and wiki documentation (it does not contain source code).
* [NorthstarMasterServer](https://github.com/R2Northstar/NorthstarMasterServer)
holds source code of the master server, which is responsible for authentication, persistence, custom servers
listing.
* [NorthstarLauncher](https://github.com/R2Northstar/NorthstarLauncher) holds source code responsible for
injecting custom content (mods) into original game files.
* [NorthstarMods](https://github.com/R2Northstar/NorthstarMods) contains mods recreating server gamelogic,
enabling custom serveurs hosting.
## Issues
### Create a new issue
If you find a bug while using Northstar, before posting it, please ensure that a corresponding issue does not
already exists.
Also, please double-check that you're opening an issue in the correct repository (read carefully `Repositories architecture`
of this document if you're not sure).