Skip to content

Latest commit

 

History

History
84 lines (73 loc) · 3.52 KB

CONTRIBUTING.md

File metadata and controls

84 lines (73 loc) · 3.52 KB

How to Contribute

We'd love to accept your patches and contributions to this project. We do have some guidelines to follow, covered in this document, but don't worry about (or expect to) get everything right the first time! Create a pull request and we'll nudge you in the right direction.

Contributor License Agreement

Contributions to this project must be accompanied by a NASA Contributor License Agreement.

Pull Request Process and Code Review

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. GitHub Help has information on using pull requests.

The preferred manner for submitting pull requests is for users to fork the qFlex repo and then use a branch from this fork to create a pull request to the main qFlex repo.

The basic process for setting up a fork is

  1. Fork the qFlex repo (Fork button in upper right corner of repo page). Forking creates a new github repo at the location https://github.com/USERNAME/qflex where USERNAME is your github id. Use the directions on the development page to download a copy to your local machine. You need only do this once.
  2. Checkout master and create a new branch from this master 
    git checkout master -b new_branch_name
    where new_branch_name is the name of your new branch.
  3. Do your work and commit your changes to this branch.
  4. If you have drifted out of sync with the master from the main qFlex repo you may need to merge in changes. To do this, first update your local master and then merge the local master into your branch: 
    # Update your local master.
git fetch upstream
git checkout master
git merge upstream/master
# Merge local master into your branch.
git checkout new_branch_name
git merge master
    You may need to fix merge conflicts for both of these merge commands.
  5. Finally, push your change to your clone 
    git push origin new_branch_name
  6. Now when you navigate to the qFlex page on github, https://github.com/ngnrsaa/qflex you should see the option to create a new pull request from your clone repository. Alternatively you can create the pull request by navigating to the "Pull requests" tab in the page, and selecting the appropriate branches.
  7. The reviewer will comment on your code and may ask for changes, you can perform these locally, and then push the new commit following the same process as above.

Code Testing Standards

When a pull request is created or updated, various automatic checks will run to ensure that the change won't break qFlex and meets our coding standards.

Please be aware of the following code standards that will be applied to any new changes.

  • Tests. Existing tests must continue to pass (or be updated) when new changes are introduced. We use pytest to run our Python tests, and googletest for C++ tests.
  • Formatting. Code should meet common style standards for python and C++, and be free of error-prone constructs. We use YAPF and clang-format to format files; running check_format.sh will identify any formatting issues and provide commands to automatically resolve them.