Skip to content

Latest commit

聽

History

History
96 lines (56 loc) 路 4.45 KB

CONTRIBUTING.md

File metadata and controls

96 lines (56 loc) 路 4.45 KB
Raw

Contributing

Code of Conduct

Help us keep sentence-classifier-based-on-word-similarity open and inclusive. Please read and follow the Code of Conduct.

Found a Bug

If you find a bug in the source code, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.

Missing a Feature

You can request a new feature by submitting an issue to our GitHub Repository. If you would like to implement a new feature, please submit an issue with a proposal for your work first, to be sure that we can use it. Please consider what kind of change it is:

  • For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.

  • Small Features can be crafted and directly submitted as a Pull Request.

Submission Guidelines

Submitting an Issue

Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.

We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, we will systematically ask you to provide a minimal reproduction scenario. Having a live, reproducible scenario gives us a wealth of important information without going back & forth to you with additional questions.

We will be insisting on a minimal reproduce scenario in order to save maintainers time and ultimately be able to fix more bugs. Interestingly, from our experience users often find coding problems themselves while preparing a minimal plunk. We understand that sometimes it might be hard to extract essentials bits of code from a larger code-base but we really need to isolate the problem before we can fix it.

Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you we are going to close an issue that doesn't have enough info to be reproduced.

You can file new issues by filling out the new issue form.

Submitting a Pull Request

Before you submit your Pull Request (PR) consider the following guidelines:

  1. Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate effort.

  2. Fork this repo.

  3. Make your changes in a new git branch.

    git checkout -b my-new-feature master

  4. Commit your changes using a descriptive commit message that follows our commit message convention. Adherence to these conventions is necessary because release notes are automatically generated from these messages.

    git commit -am 'Add some feature'

  5. Push your branch.

    git push origin my-new-feature

  6. Send a pull request :D

That's it! Thank you for your contribution!

After your pull request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:

  • Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:

    git push origin --delete my-new-feature

  • Check out the master branch:

    git checkout master -f

  • Delete the local branch:

    git branch -D my-new-feature

  • Update your master with the latest upstream version:

    git pull

Commit Message Convention

We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the change log.

Please read and follow the Commit Message Format.