Skip to content

Latest commit

 

History

History
179 lines (121 loc) · 6.58 KB

CONTRIBUTING.md

File metadata and controls

179 lines (121 loc) · 6.58 KB
Raw

Contributing

As a community-focused, open source project, contributions are always welcome, no matter how large or small. Here are the guidelines we ask our contributors to follow:

NOTE

While we complete our transition to version 2.0, please adhere to the following:

  • For any contributions to our 2.0 track, please create a topic branch based off our master branch, push said topic branch onto your fork and submit your pull request from that branch.
  • Anyone wishing to contribute a bug fix to our 1.x track, please create a topic branch based off our 1.x branch, push said topic branch onto your fork and submit your pull request from that branch..

Code of Conduct

We want to keep our project open and inclusive. We ask that before you contribute, you read and follow our Code of Conduct.

Found an Issue?

We definitely want to hear from you!

If you find a bug in the source code or a mistake in the docs, you can help us by submitting an issue to our Repository. Make sure you search through our existing open and closed issues in order to avoid duplicate submissions.

Want to contribute with a fix? Even better! Just submit a Pull Request.

Please read the Submission Guidelines below.

Want a Feature?

Need a new feature no yet available on node-mocks-http? Submit a new feature to our GitHub Repository.

Think you can help us out by implementing the feature yourself? Go for it! Just craft and submit your Pull Request.

Please read the Submission Guidelines below.

Submission Guidelines

Submitting an Issue

Before you submit your issue search the archive, maybe your question was already answered. Let's avoid duplicates.

If you believe your issue is a bug, and you can't find a issue in the archive, just open a new issue.

Help us help you!

Provide the following information to help us identify and fix the issue in a timely manner:

  • Overview - describe the issue the best way you can, and if possible include a stack trace
  • Use Case - explain why you consider this a bug
  • Version(s) - tell us what version of node-mocks-http you're currently using
  • Reproduce - it would be awesome if you could provide a live example (using Plunker or JSFiddle), or at least a step-by-step description on how to reproduce it
  • Suggestions - if you have identified the lines of code or the commit responsible for the problem please include it as well

Submitting a Pull Request

We are a Pull Request-friendly project!

Your pull requests are always welcome. We only ask that you adhere to the following guidelines before you submit your pull request:

  • Search GitHub for an open or closed Pull Request that may be similar to yours. Avoid duplicates!

  • Fork our repo and create a local clone, if you haven't done so already.

    git clone https://github.com/YOUR-NAME/node-mocks-http.git

  • If you had previously cloned the repo, make sure you sync it with the upstream repository.

    git remote add upstream https://github.com/howardabrams/node-mocks-http.git
git fetch upstream
git checkout master
git merge upstream/master

  • Create a new topic branch:

    git checkout -b my-awesome-fix master

  • Now do your thing! Create your fix/patch, including appropriate test cases.

  • Follow our Coding Rules.

  • Run our test suite, as described in below, and ensure that all tests pass.

  • Commit your changes using a descriptive commit message

    git commit -a

    Note: the optional commit -a command line option will automatically "add" and "rm" edited files.

  • Push your branch to GitHub:

    git push origin my-awesome-fix

  • In GitHub, send a pull request to node-mocks-http.

  • If we find any issues we may suggest that you:

    • Make the required updates.

    • Re-run the test suite to ensure tests are still passing.

    • Rebase your branch and force push to your GitHub repository (this will update your Pull Request):

      git rebase master -i
git push origin my-awesome-fix -f

That's it!

Post merged cleanup

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

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

    git push origin --delete my-awesome-fix

  • Check out the master branch:

    git checkout master -f

  • Delete the local branch:

    git branch -D my-awesome-fix

  • Update your master with the latest upstream version:

    git pull --ff upstream master

Coding Rules

For a detailed list our the conding conventions used in our project please read our Coding Rules.

Running Test Suite

Navigate to the project folder and run npm install to install the project's dependencies.

Then simply run the tests. This also checks that the code adheres to the ESLint rules.

npm test

Also, please adhere to the ESLint's rules by running the following:

npm install -q gulp
gulp lint

Failures in the linting process may fail our continuous integration builds.

Thanks again for helping out!

Contact Us

Gitter chat

If you have any other questions or comments about node-mocks-http that do not fall under the category of issues, bugs, or feature requests, feel free to join us on our Gitter channel.