Skip to content

Latest commit

 

History

History
40 lines (32 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

40 lines (32 loc) · 1.55 KB

Contributing

The following guidelines will give you a short overview of how we handle issues and PRs in this repository.

All valuable contributions are appreciated - bug reports, documentation and design enhancements, issues as well as Pull Requests to make this application more convenient, functional and bug free.

To begin contributing have a look at the open issues here.

Development Setup

  1. Clone the repository
git clone https://github.com/sarthak-mittal/sudoku.git
cd sudoku
  1. Install dependencies
npm install
  1. Run the project
ng serve

Creating Issues

  • Provide detailed description about the issue and mark it with the relevant labels.
  • If it's a bug, provide steps to reproduce the bug. If possible suggest the ways to resolve it.
  • If it's a feature request, share your thoughts about the final outcome.
  • Don't create duplicate issues, checkout the issue section before reporting it.

Submitting Pull Requests

  • Request assignment to the issue before working
  • Provide the reference to the issue, for which pull request is created
  • Provide detailed description about the changes you have made and the expected outcome, feel free to share images/gif for the outcome.
  • Don't submit independent PR's. First create issue, once approved, submit your PR.

Assigning issues

  • Only start working on issues, once assigned by the maintainers.
  • Don't request assignment on more than one issue at a time.
  • Issues will be unassigned, if there's no action/updates from the assignee.