Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Create contributors.md #3

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Create contributors.md #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions contributors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
So you want to help make chisel better? Awesome! Here’s how:

## tl;dr:
* Have a usage question? Ask on Stack Overflow.
* Found a bug? Open an issue
* Proposing a significant change? Consider opening an issue as a RFC first, to get feedback and consensus
* Got code? Open a pull request and pick a reviewer. All pull requests are reviewed before being merged.
* Check out our style guide

## Issue Guidelines
* First search to see whether a similar issue has been raised
* If not, start a new issue by following our issue template
* Forewarning - given our slim development team, low priority issues that require code modifications don’t have a high likelihood of being handled in a timely fashion. However, we will try to reply to your issue.
* We love welcoming new contributors, so if resolving your issue requires a small change, we highly encourage you to take the plunge and submit a pull request! Our reviewer team is more than happy to work with you to get your pull request up to par and merged (and hey, who doesn’t love learning something new?!).

### Milestones
* Every few months or so, the repo admins get together and prioritize which issues should be tackled in the coming months.
* We try to stick to the milestone labels, but no guarantees (given all our developers volunteer their time, it’s not always possible to stick to a schedule).
* If you disagree with how milestones have been assigned, just say something! We value your feedback.

### RFC Guidelines

TODO (look at PEP / SIP / etc)

## Pull Request Review Process

Before submitting code, please make sure code conforms to the style guide. It will reduce the number of review
iterations which saves everyone time (especially you!).

As provided by the pull request template, please indicate the impact of your PR (to the best of your knowledge):
* API Modification (change to existing APIs or behavior)
* API Addition (added API that will require backwards compatibility)
* No functional change (e.g. bug-fixes, performance enhancements)

TODO include more information