diff options
| author | Jacob Hoffman-Andrews <github@hoffman-andrews.com> | 2016-09-27 02:44:27 +0300 |
|---|---|---|
| committer | Brad Warren <bmw@users.noreply.github.com> | 2016-09-27 02:44:27 +0300 |
| commit | 1d552630fc67473ae446d169f37857a4a8c9f0b6 (patch) | |
| tree | 067b9513d4f42a36f08eb78cbe5cfb049e8bd7b6 /CONTRIBUTING.md | |
| parent | 9f2dfc15feea55e0844aa046167979e163444c68 (diff) | |
Update CONTRIBUTING.md to be more welcoming. (#3540)
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5f1625658..d740b7d89 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,4 +15,21 @@ to the Sphinx generated docs is provided below. --> -https://certbot.eff.org/docs/contributing.html +# Certbot Contributing Guide + +Hi! Welcome to the Certbot project. We look forward to collaborating with you. + +If you're reporting a bug in Certbot, please make sure to include: + - The version of Certbot you're running. + - The operating system you're running it on. + - The commands you ran. + - What you expected to happen, and + - What actually happened. + +If you're a developer, we have some helpful information in our +[Developer's Guide](https://certbot.eff.org/docs/contributing.html) to get you +started. In particular, we recommend you read these sections + + - [Finding issues to work on](https://certbot.eff.org/docs/contributing.html#find-issues-to-work-on) + - [Coding style](https://certbot.eff.org/docs/contributing.html#coding-style) + - [Submitting a pull request](https://certbot.eff.org/docs/contributing.html#submitting-a-pull-request) |