Skip to content

Latest commit

聽

History

History
36 lines (33 loc) 路 1.27 KB

CONTRIBUTING.md

File metadata and controls

36 lines (33 loc) 路 1.27 KB
Raw

How to contribute 馃彈

Rules

  • Rule #1: Keep it as simple as possible! Avoid usage of 3rd party libraries, frameworks, etc.
  • Rule #2: Really, keep it simple.

Discussions and agreement

Before you start working on something, please make sure we have thoroughly discussed it in the corresponding issue thread and we have agreed on an implementation. Also, check if there is not already a PR where someone else is working on the same problem.

Basic development flow

  1. Clone the repo:
$ git clone [email protected]:rdlf0/minesweeper.git
  1. Create a new feature branch with good descriptive name:
$ git checkout master
$ git pull
$ git checkout -b super-cool-feature
$ git push -u origin super-cool-feature
  1. Implement the feature/bug fix - in order to get your changes compiled on save and also get their correspodning .map files generated (for easier debugging), you might find it convenient to run:
$ tsc --sourceMap -w
  1. Commit your changes:
$ git commit -am "Something descriptive but concise about the changes I made"
  1. Push to the branch:
$ git push
  1. Repeat 3-5 as needed
  2. Test your changes locally
  3. Create a new pull request - assign it to yourself, add some appropriate tags and link it to the corresponding issue