Skip to content

Latest commit

 

History

History
126 lines (97 loc) · 5.33 KB

CONTRIBUTING.md

File metadata and controls

126 lines (97 loc) · 5.33 KB
Raw

Contributing

Bond welcomes contributions from the community.

Process

  1. Make a proposal.
  2. Implement the proposal and its tests.
  3. Squash commits and write a good commit message.
  4. Start a pull request & address comments.
  5. Merge.

Proposal

For things like fixing typos and small bug fixes, you can skip this step.

If your change is more than a simple fix, please don't just create a big pull request. Instead, start by opening an issue describing the problem you want to solve and how you plan to approach the problem. This will let us have a brief discussion about the problem and, hopefully, identify some potential pitfalls before too much time is spent.

Implementation

  • Fork the repository on GitHub.
  • Start on a new topic branch off of master.
  • Instructions for getting Bond building and running the tests are in the README.
  • Aim for each pull request to have one commit. If the commit starts to get too large, consider splitting it into multiple, independent pull requests.
    • Some changes are more naturally authored in multiple commits. This is fine, though we find this to be a rare occurrence. These sort of changes are harder to review and interate on with GitHub's tooling.
  • Make sure that all the tests continue to pass.
    • The CMake check target will run the C++ tests for you.
    • The C# unit tests can be run from the command line or from within Visual Studio.
  • Update the changelog.

Squash commits

Before submitting your pull request, you'll probably want to squash any intermediate commits you have into one commit. No "fix syntax error" commits, please. :-)

Each commit should build and pass all of the tests. If you want to add new tests for functionality that's not yet written, ensure the tests are added disabled.

  • For Haskell tests, add the tests functions, but don't add a test case for them.
  • For CTest tests, add the executable to the CMakeLists.txt file to ensure that it builds, but do not include a add_test() (or similar) entry for it.
  • For C# NUnit tests, use the [Ignore] attribute to annotate the test cases to be ignored.

Don't forget to run git diff --check to catch those annoying whitespace changes.

In your commit message, explain the reasoning behind the commit. The code changes answer the question "What changed?", but the commit message answers the question "Why did it need to change?".

Please follow the established Git convention for commit messages. The first line is a summary in the imperative, about 50 characters or less, and should not end with a period. An optional, longer description must be preceded by an empty line and should be wrapped at around 72 characters. This helps with various outputs from Git or other tools.

You can update messages of local commits you haven't pushed yet using git commit --amend or git rebase --interactive with reword command.

Pull request

Start a GitHub pull request to merge your topic branch into the main repository's master branch. (If you are a Microsoft employee and are not a member of the Microsoft organization on GitHub yet, please contact the Bond Development team via e-mail for instructions before starting your pull request. There's some process stuff you'll need to do ahead of time.)

If you haven't contributed to a Microsoft project before, you may be asked to sign a contribution license agreement. A comment in the PR will let you know if you do.

When you submit a pull request, a suite of builds and tests will be run automatically, and the results will show up in the "Checks" section of the PR. If any of these fail, you'll need to figure out why and make the appropriate fixes. If you think the failures are due to infrastructure issues, please mention this in a comment, and one of the maintainers will help.

The project maintainers will review your changes. We aim to review all changes within three business days.

Address any review comments by adding commits that address the comments. Don't worry about having fixup/tiny commits at this stage. They'll get squashed together when the change is finally merged. Push these new commits to your topic branch, and we'll review the edits.

Merge

Once the comments in the pull request have been addressed, a project maintainer will merge your changes. Thank you for helping improve Bond!

By default we'll perform a squash merge unless requested otherwise in the PR.

Reporting Security Issues

Security issues and bugs should be reported privately to Microsoft. See our guidance for how to report these sort of issues.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.