Skip to content

Commit 7b06361

Browse files
committed
revise CONTRIBUTING.md
1 parent 5f2dc87 commit 7b06361

1 file changed

Lines changed: 5 additions & 11 deletions

File tree

CONTRIBUTING.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,12 @@
1-
# Contributing to electiondata development
2-
3-
The goal of this guide is to help you get up and contributing to electiondata as
4-
quickly as possible. The guide is divided into two main pieces:
5-
6-
1. Filing a bug report or feature request in an issue.
7-
1. Suggesting a change via a pull request.
8-
91
Please note that electiondata is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md).
102
By contributing to this project,
113
you agree to abide by its terms.
124

13-
## Issues
5+
# Contributing to electiondata development
6+
7+
## Report a Problem
148

15-
When filing an issue, the most important thing is to include a minimal
9+
To report a problem, [file an issue on GitHub](https://github.com/ElectionDataAnalysis/electiondata/issues). When filing an issue, the most important thing is to include a minimal
1610
reproducible example so that we can quickly verify the problem, and then figure
1711
out how to fix it. Please include
1812

@@ -32,7 +26,7 @@ You can check you have actually made a reproducible example by:
3226
1. if files or folders were moved by the system to the archive directory, move them back to the input directory, removing any timestamps from directory names.
3327
1. navigating to the working directory, calling python, and producing the behavior in question.
3428

35-
## Pull requests
29+
## Revise the Code
3630

3731
To contribute a change to `electiondata` follow these steps:
3832

0 commit comments

Comments
 (0)