CONTRIBUTING.md

In hepplerj/superfunds: Superfund Sites in the United States

Contributing to superfundr

:+1::tada: Thanks for taking the time to contribute! :tada::+1:

The following are guidelines for contributing to superfundr, which is hosted here on Github.

Feel free to propose changes to this document in a pull request.

Table Of Contents

What should I know before I get started?

• Code of Conduct

How Can I Contribute?

• Your First Contribution
• Suggesting Enhancements
• Pull Requests

What should I know before I get started?

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the project leads.

Superfundr

The superfundr package contains data on U.S. Superfund sites established by the Environmental Protection Agency.

How Can I Contribute?

Your First Contribution

Unsure where to begin contributing? You can start by looking through these beginner and help-wanted issues:

• Beginner issues beginner - issues which should only require a few lines of code or writing.
• Help wanted issues help-wanted - issues which should be a bit more involved than beginner issues.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for superfundr, including completely new contributions and minor improvements to existing workshops, the website, promotional material, or resources. Following these guidelines helps the project leads and the community understand your suggestion and find related suggestions.

Before creating enhancement suggestions, please check this list as you might find out that you don’t need to create one. When you are creating an enhancement suggestion, please include as many details as possible.

Before Submitting An Enhancement Suggestion

• Perform a cursory search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. Create an issue on that repository and provide the following information:

• Use a clear and descriptive title for the issue to identify the suggestion.
• Provide a step-by-step description of the suggested enhancement in as many details as possible.
• Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
• Describe the current behavior and explain which behavior you expected to see instead and why.
• Explain why this enhancement would be useful to superfundr.
• List some other events or applications where this enhancement exists.

Pull Requests

Once you’ve identified one of the issues above that you feel you can contribute to, you’re ready to make a change to the project repository!

1. Fork this repository. This makes your own version of this project you can edit and use.
2. Make your changes! You can do this in the GitHub interface on your own local machine. Once you’re happy with your changes…
3. Submit a pull request. This opens a discussion around your project and lets the project lead know you are proposing changes.

First time contributing to open source? Check out this free series, How to Contribute to an Open Source Project on GitHub.

hepplerj/superfunds documentation built on Dec. 6, 2019, 3:40 p.m.