Skip to content

Latest commit

 

History

History
executable file
·
85 lines (51 loc) · 3.52 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
85 lines (51 loc) · 3.52 KB
Raw

Contribution Guide

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a issue
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Updating the docs

All Changes Happen Through Pull Requests

Pull requests are the best way to propose changes. We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add some tests' example.
  3. If you've changed APIs, update the documentation.
  4. Issue that pull request!

Local Development

Before running the app locally make sure you have installed following things :

  • Node >= 14.15.4
  • npm >= 6.14.10

For contributing the project:

  • Fork this repository.

  • Clone the repo.

$ git clone https://github.com/:your-github-username/states-nepal
  • Install dependencies
$ yarn install

Report issues/bugs using GitHub's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Before filing an issue

  • Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
  • Check to make sure your feature suggestion isn't already present within the project.
  • Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
  • Check the pull requests tab to ensure that the feature isn't already in progress.

Implement New Feature

If you're planning to implement a new feature I will recommend you to discuss with me before you start coding so you won't end up working on something that I don't want to implement. Create an Issue with proper name and content for discussion.

Commit and PR Title

It’s good to have descriptive commit messages so that other folks can make sense of what your commit is doing. This project uses Husky prevent bad git commit, git push and more 🐶 _woof!

Read conventional commits before making the commit message.

Requirements

If the project maintainer has any additional requirements, you will find them listed here.

  • Add tests! - Your patch won't be accepted if it doesn't have tests.

  • Document any change in behaviour - Make sure the README.md and any other relevant documentation are kept up-to-date.

  • One pull request per feature - If you want to do more than one thing, send multiple pull requests.

  • Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.

Contact

If you need any help, you can always drop me a message on my Twitter @adarshatweets or drop me an email at connectwithadarsha@gmail.com.

License

By contributing, you agree that your contributions will be licensed under its MIT License. In short, when you submit changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.