2015-03-22 10:07:58 -04:00
|
|
|
<!---
|
|
|
|
|
|
|
|
|
|
This file serves as an entry point for GitHub's Contributing
|
|
|
|
|
Guidelines [1] only.
|
|
|
|
|
|
|
|
|
|
GitHub doesn't render rST very well, especially in respect to internal
|
|
|
|
|
hyperlink targets and cross-references [2]. People also tend to
|
|
|
|
|
confuse rST and Markdown syntax. Therefore, instead of keeping the
|
|
|
|
|
contents here (and including from rST documentation under doc/), link
|
|
|
|
|
to the Sphinx generated docs is provided below.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[1] https://github.com/blog/1184-contributing-guidelines
|
2020-09-23 13:36:55 -04:00
|
|
|
[2] https://docutils.sourceforge.io/docs/user/rst/quickref.html#hyperlink-targets
|
2015-03-22 10:07:58 -04:00
|
|
|
|
|
|
|
|
-->
|
|
|
|
|
|
2016-09-26 19:44:27 -04:00
|
|
|
# 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)
|
2019-04-16 19:28:32 -04:00
|
|
|
- [EFF's Public Projects Code of Conduct](https://www.eff.org/pages/eppcode)
|
|
|
|
|
|
