Skip to content

Latest commit

 

History

History
160 lines (118 loc) · 6.36 KB

CONTRIBUTING.md

File metadata and controls

160 lines (118 loc) · 6.36 KB
Raw

#Contributing to End-To-End

We'd love for you to contribute to our source code! Here are the guidelines we'd like you to follow:

Got a Question or Problem?

If you have questions about End-To-End, please direct these to the Google Group discussion list.

Found an Issue?

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. NEVER put your private key in a description/comment to the issue. If needed, you can create a throw away key only to ease bug reproduction.

Want 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 then consider what kind of change it is:

  • Major Changes that you wish to contribute to the project should be discussed first on our Google Group so that we can 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 Changes can be crafted and submitted to the GitHub Repository as a Pull Request.

In addition, some changes might be applicable to the upstream Google End to End repository. Most changes to the crypto library and build scripts would belong there as well as here, for instance. You should open these changes as pull requests to the Google repo and tag us for review.

Submission Guidelines

Submitting an Issue

Before you submit your issue search the archive, maybe your question was already answered.

If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. Providing the following information will increase the chances of your issue being dealt with quickly:

  • Overview of the Issue - if an error is being thrown a non-minified stack trace helps
  • Motivation for or Use Case - explain why this is a bug for you
  • Related Issues - has a similar issue been reported before?
  • Suggest a Fix - if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)

Submitting a Pull Request

Before you submit your pull request consider the following guidelines:

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

  • Please sign our Contributor License Agreement (CLA) before sending pull requests. We cannot accept code without this.

  • Please be succinct. Create separate pull requests for separate bug fixes/features.

  • Make your changes in a new git branch:

    git checkout -b my-fix-branch master

  • Create your patch, including appropriate test cases.

  • Follow our Coding Rules.

  • Run linter to spot and correct any styling errors in the code:

    ./do.sh lint

    If any fixable errors are present, Closure Linter will display a command that would fix those.

  • Run the full test suite. Start the test server:

    ./do.sh testserver

    Visit [http://localhost:8000/all_tests.html] and ensure all tests pass in your browser.

  • Build your changes locally to ensure the build is not broken:

    ./do.sh build_extension
./do.sh build_library

  • Push your branch to GitHub:

    git push origin my-fix-branch

  • In GitHub, send a pull request to yahoo:master.

  • If we suggest changes then

    • Make the required updates.

    • Re-run the test suite, builds and linter to ensure the code is still healthy.

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

      git rebase master -i
git push -f

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-fix-branch

  • Check out the master branch:

    git checkout master -f

  • Delete the local branch:

    git branch -D my-fix-branch

  • Update your master with the latest upstream version:

    git pull --ff upstream master

Coding Rules

To ensure consistency throughout the source code, keep these rules in mind as you are working:

  • End-To-End is based on Google Closure library. Make sure the code you're submitting adheres to Closure principles.
  • All features or bug fixes must be tested using Closure unit test suites.
  • We follow ALL the rules contained in Google's JavaScript Style Guide
  • All public API methods must be documented. This includes adding type annotations for input parameters and return values.

Signing the CLA

Please sign our Contributor License Agreement (CLA) before sending pull requests. For any code changes to be accepted, the CLA must be signed. It's a quick process, we promise!

  • You can sign the Yahoo CLA here.