Skip to content

Latest commit

 

History

History
22 lines (13 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

22 lines (13 loc) · 1.37 KB

Thank you for considering making a contribution to Name Match! Below are some guidelines to help your contribution have the most impact.

Requesting features

There are a lot of cool features that could be added to improve or expand Name Match. Some we are aware of, some we are not. If you have an idea specific to your use case, please write in to tell us about it. New features will be added as time allows, prioritized by expected impact.

Reporting issues

If you experience an issue using Name Match, please let us know! However, the first step should be to review the documentation and tutorial to make sure the issue hasn't been addressed -- this is likely the fastest option for getting past a roadblock. If you are still having problems, please create an issue with as much detail as possible (including the full error message, when applicable).

Contributing code or documentation

One of the goals of open sourcing Name Match was to allow others to help us add features and solve problems. If you'd like to contribute code, documentation, or examples to Name Match:

  1. Fork the project
  2. Create your feature branch (git checkout -b some-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin some-feature)
  5. Open a pull request

Pull requests will be reviewed and accepted as time allows.