Thanks for considering contributing and making our planet easier to explore!
We'd be quite excited if you'd like to contribute to Worldview! Whether you're finding bugs, adding new features, fixing anything broken, or improving documentation, get started by submitting an issue or pull request!
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.
If you want to submit your own contributions, follow these steps:
- Fork the Worldview repo.
- Create a new branch from the branch you'd like to contribute to.
- Note: If you're not branching from an existing feature branch, create your branch from
developfor the majority of contributions. Branching frommainis reserved for urgent patches. - If an issue doesn't already exist, submit one.
- Create a pull request from your fork into the target branch of the
nasa-gibs/worldviewrepo. - Be sure to mention the issue number in the PR description, i.e. "Fixes #480".
- Make sure to set the base branch to
develop. - Upon submission of a pull request, the Worldview development team will review the code.
- The request will then either be merged, declined, or an adjustment to the code will be requested.
We ask that you follow these guidelines with your contributions:
Please lint your code with npm run lint. Our style rules are defined in
.stylelintrc and .eslintrc. We follow a modified version of
Standard JS Rules, with
semi-colons. You can install linting plugins in your editor to check against
our style guides automatically:
All of the unit tests for this project need to pass before your submission will be accepted. If you add new functionality, please consider adding tests for that functionality as well. See Testing for more information about testing.
- 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 #480
Improve contributing docs and consolidate them in the standard location https://help.github.com/articles/setting-guidelines-for-repository-contributors/
Please see our Roadmap for an overview of what we're planning. We also track the progress of Worldview using the public ZenHub Projects Board.
We use GitHub labels to organize issues we're working on. Here are the labels we use, along with descriptions of what they mean. Click on the headings or badges below to see the GitHub issues tagged with each label.
Things that appear to be broken or are not working as intended.
An issue that requires an update to our documentation.
An enhancement to an existing feature.
A large objective consisting of multiple issues.
Issues that are waiting on something out of our control.
These issues might be a good place to start if you want to contribute for the first time.
These issues might be a good place to start if you want to contribute.
These are ideas, user stories, or feature requests that don't yet qualify as a new feature, probably because the specifics haven't been worked out yet.
These are issues that are no longer relevant or are not considered valid issues.
These are issues that require further investigation to be considered as valid issues.
These are new features to be developed at some point in the future.
These are issues that require changes outside of the code repository.
These are questions related to a problem and/or issues that require further investigation.
These are issues which require minimal effort to address.
These are issues which address a known vulnerability.
These are issues which were found during systems integration testing (SIT).
These issues are related to our technical implementation (refactoring, dependency changes, etc.), they're developer focused, and don't directly add new features for end users.
These are issues which were found during user acceptance testing (UAT).
These are issues that we don't plan to fix.