-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated to use Sean's contributing guide from NASA-PDS/template-repo-…
- Loading branch information
Showing
1 changed file
with
20 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,20 @@ | ||
# How to Contribute | ||
|
||
First, thank you for interest in contributing to NASA's Planetary Data System! The following document aims to get new people the all the information necessary for making contributions to the PDS. | ||
If you find something that would be helpful to add please open a pull request! | ||
|
||
## Code of Conduct | ||
|
||
We at PDS pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. We expect all contributors and community members to do the same. The [PDS Code of Conduct](https://github.com/NASA-PDS/.github/blob/master/CODE_OF_CONDUCT.md) defines these expectations along with information on how to report unacceptable behavior. | ||
|
||
## Getting Started | ||
|
||
We maintain the [Getting Started with PDS EN](https://github.com/NASA-PDS/nasa-pds.github.io/wiki/Getting-Started-with-PDS-EN) page with information helpful to people new to the PDS Engineering Node. | ||
|
||
## Development | ||
|
||
PDS EN software spans a number of domains and languages. We attempt to follow industry best practices relevant to each project while also maintaining consistency across the organization. Each repository maintains a README with instructions specific to that project's development practices. This includes instructions on build processes, testing, and software support tooling. Default templates are present for issues and pull request formatting to assist with those processes. Additional information can be found in our [Developer Guides](https://github.com/NASA-PDS/nasa-pds.github.io/wiki/Developer-Guides). | ||
|
||
#### Committing Changes | ||
|
||
For commit message best practices, the PDS tries to follow these [Github Commit Messages Guidelines](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53) where possible. Once you have read through the guidelines, check out our [commit message best practices](https://github.com/NASA-PDS/nasa-pds.github.io/wiki/Git-and-Github-Guide#commit-message-best-practices) for additional notes. | ||
|
||
#### Issues | ||
|
||
The PDS uses the [Naming Guide for Task, Bug, and User Story Titles](https://stratejos.ai/blog/naming-task-bug-user-story-titles/) article for echance and bug issue creation best practices. Additionally, check out our [Issue Tracking](https://github.com/NASA-PDS/nasa-pds.github.io/wiki/Issue-Tracking) page for further explanations. | ||
# 👥 Contributing | ||
|
||
When contributing to this repository, first off, a moment of gratitude: 🙏 Thanks for wanting to help out! | ||
|
||
Whether submitting a bug report, making a pull request, asking for a new feature, or fixing some documentation, these are all _contributions_. Please review these guidelines in order to make your contribution shine! | ||
|
||
- **Is it a security vulnerability?** If so, please check out our [security policy](../SECURITY.md). | ||
- **Is it a bug?** | ||
- Check the issue tracker to see if it's already been reported or if something similar's been reported. | ||
- If you can't find it, submit a new issue using the "bug" issue type. | ||
- **Is it a code patch?** | ||
- Open a new GitHub "pull request" with your patch. | ||
- Make sure you describe the problem you're addressing (include links to issues if you can) and the solution you're proposing. | ||
- **Is it a cosemtic change, such as to code formatting, white space, etc.?** We generally don't use these kinds of contributions. | ||
- Cosmetic changes create unnecessary work in reviewing them as well as noise in the commit history. | ||
- They also make backporting bugs a lot more difficult. | ||
- **Is it a request for a new behavior or new feature?** Submit an issue using the "new feature" issue type. | ||
- **Is it a question about the code?** You can [send us email](mailto:Jordan.Padams@jpl.nasa.gov). | ||
|
||
Once again, thank you! ❤️ |