Skip to content

Latest commit

 

History

History
55 lines (29 loc) · 3.28 KB

CONTRIBUTING.md

File metadata and controls

55 lines (29 loc) · 3.28 KB
Raw

Contributing

Pull requests are very welcome, but should be within the scope of the project, and follow the repository's code conventions. Before submitting a pull request, it's always good to file an issue, so we can discuss the details of the PR.

Reporting a Bug

  1. Ensure you've replicated the issue against master. There is a chance the issue may have already been fixed.

  2. Search for any similar issues (both opened and closed). There is a chance someone may have reported it already.

  3. Provide a demo of the bug isolated in a jsfiddle/jsbin. Sometimes this is not a possibility, in which case provide a detailed description along with any code snippets that would help in triaging the issue. If we cannot reproduce it, we will close it.

  4. The best way to demonstrate a bug is to build a failing test. This is not required, however, it will generally speed up the development process.

Submitting a pull request

  1. At Yahoo, we have a single Yahoo Open Source Contributor License Agreement that we ask contributors to electronically sign before merging in their Pull Requests. Here's the CLA's human-readable summary:

You are saying that you have the right to give us this code, which is either your own code, or code that your company allows you to publish. You want to give us this code. We may decide to use this code. You are not going to sue people who use this code, because, after all, you are giving it to an open source project! And if you include code that you didn't write, you'll tell us about it by including the open source license to such code in your contribution so we'll know about it. You are not promising that this code works well, or that you will support it, and we're OK with that.

  1. Fork the repository.

  2. Ensure that all tests are passing prior to submitting.

  3. If you are adding new functionality, or fixing a bug, provide test coverage.

  4. Follow syntax guidelines detailed below.

  5. Push the changes to your fork and submit a pull request. If this resolves any issues, please mark in the body resolve #ID within the body of your pull request. This allows for github to automatically close the related issue once the pull request is merged.

  6. Last step, submit the pull request!

Releasing a new version

The following the process to release a new version of the react-intl package on npm. This repo uses a protected master branch so the process involves creating a Pull Request for the version bump:

  1. Make sure local node_modules is up to date: rm -rf node_modules && npm install.

  2. Create a release branch from master: git checkout -b release

  3. Bump version using npm version and choose appropriate patch, minor, major argument.

  4. Create a Pull Request for your local release branch so Travis CI tests run.

  5. If all the tests pass successfully, publish your local release branch to npm: npm publish.

  6. Push the Git tag to the main fork: git push upstream --tags.

  7. Merge the release branch PR into master and make sure to create a merge commit so the Git tag matches.

  8. Create a release post for the new release Git tag.