Skip to content

Latest commit

 

History

History
62 lines (52 loc) · 2.94 KB

CONTRIBUTING.MD

File metadata and controls

62 lines (52 loc) · 2.94 KB
Raw

Please direct any questions to @Leotsarev or leo@joinrpg.ru

How to build locally

This guide presumes that you have Windows. If you have other OS, you should replace Windows-specific components with respective counterparts. I.e. VS → VS Code.

  1. Start with forking this repository on github.
  2. Download Visual Studio 2019. Community Edition should be enough.
  3. Recommended to install Github Extension (options during install). See more on https://visualstudio.github.com/.
  4. Download .Net Core 5 SDK.

Download SQL Server Express LocalDB 2017 and important! download the latest cumulative update for SQL Server 2017

  1. Create an instance of localdb from command prompt, if you don't have any
    sqllocaldb create MSSQLLocalDB
  2. Input you github credentials into Visual Studio and clone your repository. Or clone repository using Git cmd client or Github for windows or whatever you like.
  3. Perform the following git commands (you may need to restart VisualStudio in order to see newly added remote repository under TeamExplorer):
  • git remote add upstream https://github.com/joinrpg/joinrpg-net.git
  • git fetch upstream
  1. Compile VS project and observe package restoring and everything happens
  2. Tap F5 and you should be there.
  3. First start can take a long time while Local DB will create database for first time.
  4. If you got error about "The argument 2 of the JSON_MODIFY should be string literal", you have outdated version of LocalDb. Updating it could be tricky, see here
  5. If you don't have Joinrpg/App_Data folder in your solution directory, create it. Otherwise you may get System cannot find the file specified error on database creation stage.
  6. Some features will be disabled — it's all about integration to Remote systems — email, social services login etc. If you want to test this, you will need to provide correct keys in appsettings.json.
  7. First logged-in user will have his email automatically confirmed and adminstrator flag will be set. If you want more users, you have to change DB or setup mail integration.

Submitting your changes

  1. 1 branch = 1 feature.
  2. Test your changes locally, etc.
  3. Execute dotnet format, to apply project's code styles
  4. Commit.
  5. Rebase your changes on top of upstream/master
  6. Open pull request via Github UI from your branch to joinrpg/joirpg-net/master

Telegram chats

We using a lot of telegram chats to talk about Joinrpg. Developer's question could be addressed to https://t.me/joinchat/AAAAAEKdDvRjI0Z1n79EJA сhat.

Code guidelines

Some common code practices, used amongst this repository

  • If possible, avoid the usage of regular expressions