Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 1.87 KB

Contributing to NepDate

A big welcome and thank you for considering contributing to NepDate open source projects! It’s people like you that make it a reality for users in our community.

Quick Links

Getting Started

Contributions are made to this repo via Issues and Pull Requests (PRs). A few general guidelines that cover both:

  • Search for existing Issues and PRs before creating your own.

Issues

Issues should be used to report problems with the library, request a new feature, or to discuss potential changes before a PR is created. If you find an Issue that addresses the problem you're having, please add your own reproduction information to the existing issue rather than creating a new one.

Pull Requests

PRs to this library are always welcome and can be a quick way to get your fix or improvement slated for the next release. In general, PRs should:

  • Only fix/add the functionality in question OR address wide-spread whitespace/style issues, not both.
  • Add tests for fixed or changed functionality (if a test suite already exists).
  • Address a single concern in the least number of changed lines as possible.

For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.

In general, let's follow these steps

  1. Fork the repository to your own Github account
  2. Clone the project to your machine
  3. Create a branch locally with a succinct but descriptive name
  4. Commit changes to the branch
  5. Following any formatting and testing guidelines specific to this repo
  6. Push changes to your fork
  7. Open a PR in our repository and follow the PR template so that we can efficiently review the changes.