diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 64a3685c3..3c2d196e9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,8 +2,11 @@ Welcome to Barotrauma's GitHub repository! If you're here to report an issue or to contribute to the development, please read the instructions below before you do. +## I have a question! +Please check [our FAQ](https://barotraumagame.com/faq/) in case the question has already been answered. If not, you can post the question on the [Barotrauma discussion forum](https://undertowgames.com/forum/viewforum.php?f=17) or stop by at our [Discord Server](https://discordapp.com/invite/xjeSzWU). + ## Reporting a bug -If you've encountered a bug, you can report it in the issue tracker. Please follow the instructions in the issue template to make it easier for us to diagnose and fix the issue. +If you've encountered a bug, you can report it in the [issue tracker](https://github.com/Regalis11/Barotrauma/issues). Please follow the instructions in the issue template to make it easier for us to diagnose and fix the issue. ## Code contributions Before you start doing modifications to the code or submitting pull requests to the repository, it is important that you've read and understood (at least the human-readable summary part) of [our EULA](https://github.com/Regalis11/Barotrauma/blob/master/EULA.txt). To sum it up, Barotrauma is not an open source project in the sense of free, open source software that you can freely distribute or reuse. Event though the early versions of the game have been available for free, the game will eventually have a price tag. If you're not comfortable with your contributions potentially being used in a commercial product, do not submit pull requests to the repository. @@ -11,10 +14,11 @@ Before you start doing modifications to the code or submitting pull requests to ### Getting started Installing Visual Studio You need a version of Visual Studio that supports C# 6.0 to compile game. If you don't have a compatible version of Visual Studio installed, you can get Visual Studio Community 2017 from the following link: https://visualstudio.microsoft.com/downloads/ + Make sure you select ".NET desktop development" during the install process to make sure you have the required features to work with Barotrauma. ### Installing dependencies -We use NuGet to make the solution dowload most of the required libraries and dependencies automatically, but you also need to make sure you have the OpenAL audio library installed. +We use NuGet to make the solution download most of the required libraries and dependencies automatically, but you also need to make sure you have the OpenAL audio library installed. You can get OpenAL from the following link: https://www.openal.org/downloads/oalinst.zip ### Building the game @@ -25,9 +29,10 @@ Unless you want to work on the dedicated server, you should make sure Barotrauma Next you should choose the build configuration. When developing on Windows, choose either DebugWindows or ReleaseWindows. The debug build configuration includes some features that make debugging and testing a little easier: things such as additional console commands, being able to move the submarine with the IJKL keys and allowing clients to use any console command in multiplayer. The debug builds don't create crash reports when an unhandled exception occurs - the intention behind this is to allow exceptions to be caught by the debugger instead of having the game close and write a report. ### Programming guidelines -Coding style We (loosely) follow the C# naming and coding conventions recommended by Microsoft. + https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/naming-guidelines + https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/inside-a-program/coding-conventions ### Commit messages diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md deleted file mode 100644 index 2305e4aec..000000000 --- a/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,16 +0,0 @@ -# Issue template - -### Prerequisites -- [ ] I have searched the issue tracker to check if the issue has already been reported. - -### Version -[Which version of the game did the bug happen in. Also, please include the operating system you're using (Windows/Linux/Mac).] - -### Description -[Describe the issue here] - -### Steps to reproduce -[If possible, describe how the developers can reproduce the issue. It is often extremely hard to fix a bug if we don't know how to make it happen.] - -### Additional information -[Any additional information that might be helpful in fixing the issue. Save files, submarine files, screenshots, etc...] diff --git a/README.md b/README.md index d39cd174f..18d59cea5 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,10 @@ Copyright © Undertow Games 2017-2018 Before downloading the source code, please read the [EULA](EULA.txt). +If you have a question or an issue to report, please check our [Contribution Guideline](https://github.com/Regalis11/Barotrauma/blob/master/CONTRIBUTING.md). + +If you're interested in working on the code, either to develop mods or to contribute something to the repository, you will also find instructions in the [Contribution Guideline](https://github.com/Regalis11/Barotrauma/blob/master/CONTRIBUTING.md). + ## Links: **Official Website:** www.barotraumagame.com