Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

49 lines (32 loc) · 2.9 KB
Raw

Contributing

Thanks for considering contributing and making our planet easier to explore!

We're excited you would like to contribute to Cumulus! Whether you're finding bugs, adding new features, fixing anything broken, or improving documentation, get started by submitting an issue or pull request!

Submitting an Issue

If you have any questions or ideas, or notice any problems or bugs, first search open issues to see if the issue has already been submitted. We may already be working on the issue. If you think your issue is new, you're welcome to create a new issue.

Pull Requests

If you want to submit your own contributions, follow these steps:

  • Fork the Cumulus Dashboard repo
  • Create a new branch from the branch you'd like to contribute to
  • If an issue doesn't already exist, submit one (see above)
  • Create a pull request from your fork into the target branch of the nasa/cumulus-dashboard repo
  • Be sure to mention the corresponding issue number in the PR description, i.e. "Fixes Issue #10"
  • If your contribution requires a specific version of the Cumulus API, bump (or add) the version in app/src/js/config/index.js.
    • If you don't know the Cumulus API version (because it hasn't been released), create a one-line PR with the following attributes:
      • Title: Version bump for next Cumulus API release
      • In the body, write a quick explanation and link to the unreleased Cumulus Core PR
      • Set 'change-me-next-api-release' as the value for the minCompatibleApiVersion config value.
  • Upon submission of a pull request, the Cumulus development team will review the code
  • The request will then either be merged, declined, or an adjustment to the code will be requested

Guidelines

We ask that you follow these guidelines with your contributions:

Tests

All of the automated tests for this project need to pass before your submission will be accepted. See the README for instructions on how to run tests and verify that the tests pass. If you add new functionality, please consider adding tests for that functionality as well.

Commits

  • Make small commits that show the individual changes you are making
  • Write descriptive commit messages that explain your changes

Example of a good commit message:

Improve contributing guidelines. Fixes #10

Improve contributing docs and consolidate them in the standard location https://help.github.com/articles/setting-guidelines-for-repository-contributors/

For more information on Cumulus governance, see the Cumulus Code Contribution Guidelines and the Cumulus Wiki.