Skip to content
This repository has been archived by the owner on Dec 17, 2022. It is now read-only.

Latest commit

 

History

History
21 lines (17 loc) · 1.8 KB

Contributing.md

File metadata and controls

21 lines (17 loc) · 1.8 KB

Contributing to RETCON

Getting started

To get started with contributing to RETCON you'll have to fork the repository
After forking the repository clone the forked repository onto your computer.

Requirements

The requirements for contributing to RETCON are pretty loose, but there are some things we'd like you to respect.

  • Private/Protected Variables should start with _ or m_
  • Variable and Class Names must be easy to read (Example: Application or CreateWindow())
  • C# Naming Conventions must be followed
  • All code in the projects starting with RETCON must use the RETCON namespace

Committing

Once you finish that it's time to make changes to the project. Once you made a change and you feel like it's ready to be uploaded to GitHub commit and then push them to GitHub. (Tip: Most IDEs, like Visual Studio or Rider, come with these Features built-in, use it!)

Creating a Pull Request

After you pushed your changes to your fork of RETCON and you feel like it's ready to be merged into the main project it's time to create a pull request!
Once you created a pull request a moderator of the repository will review the request, comment on it and if it meets our requirements merge it into main.

Congratulations!

You've successfully contributed to RETCON and your GitHub profile will now show up in our contributors list!