Skip to content

Latest commit

 

History

History
50 lines (40 loc) · 1.95 KB

CONTRIBUTING.MD

File metadata and controls

50 lines (40 loc) · 1.95 KB
Raw

Please direct any questions to t.me/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 2022. Community Edition should be enough.
  3. Download .Net Core 9 SDK.
  4. 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.
  5. Install docker
  6. (Optionally) Perform the following git commands to ease rebase on upstream:
  • git remote add upstream https://github.com/joinrpg/joinrpg-net.git
  • git fetch upstream
  1. Run docker compose up -d. It will start PostgreSQL and SQL Server in background.
  2. For creating DBs you can run JoinRpg.Dal.Migrate
  3. Compile VS project and observe package restoring and everything happens
  4. Tap F5 and you should be there.
  5. 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.
  6. By default, emails will be just logged.
  7. First logged-in user will have his email automatically confirmed and adminstrator flag will be set.

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