summaryrefslogtreecommitdiffhomepage
path: root/.github
diff options
context:
space:
mode:
authorMatthew Holt <[email protected]>2017-06-06 23:18:59 -0600
committerMatthew Holt <[email protected]>2017-06-06 23:18:59 -0600
commit8051c73cc3171987ba7863e118dce245eeeb6b88 (patch)
tree41afa05eaa447cf93a9c39094d80aeb7868f04d3 /.github
parenta368230ba5e4c91e5ff332be22c4a6d8073cac81 (diff)
downloadcaddy-8051c73cc3171987ba7863e118dce245eeeb6b88.tar.gz
caddy-8051c73cc3171987ba7863e118dce245eeeb6b88.zip
Add sourcegraph links to readme and contributing guide
Diffstat (limited to '.github')
-rw-r--r--.github/CONTRIBUTING.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 3b8cea6a6..42c2b5898 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -23,13 +23,13 @@ Other menu items:
### Contributing code
-You can have a direct impact on the project by helping with its code. To contribute code to Caddy, open a [pull request](https://github.com/mholt/caddy/pulls) (PR). If you're new to our community, that's okay: **we gladly welcome pull requests from anyone, regardless of your native language or coding experience.**
+You can have a direct impact on the project by helping with its code. To contribute code to Caddy, open a [pull request](https://github.com/mholt/caddy/pulls) (PR). If you're new to our community, that's okay: **we gladly welcome pull requests from anyone, regardless of your native language or coding experience.** You can get familiar with Caddy's code base by using [code search at Sourcegraph](https://sourcegraph.com/github.com/mholt/caddy/-/search).
We hold contributions to a high standard for quality :bowtie:, so don't be surprised if we ask for revisions&mdash;even if it seems small or insignificant. Please don't take it personally. :wink: If your change is on the right track, we can guide you to make it mergable.
Here are some of the expectations we have of contributors:
-- If your change is more than just a minor alteration, **open an issue to propose your change first.** This way we can avoid confusion, coordinate what everyone is working on, and ensure that changes are in-line with the project's goals and the best interests of its users. If there's already an issue about it, you can comment on the existing one to claim it.
+- If your change is more than just a minor alteration, **open an issue to propose your change first.** This way we can avoid confusion, coordinate what everyone is working on, and ensure that changes are in-line with the project's goals and the best interests of its users. If there's already an issue about it, comment on the existing issue to claim it.
- **Keep pull requests small.** Smaller PRs are more likely to be merged because they are easier to review! We might ask you to break up large PRs into smaller ones. [An example of what we DON'T do.](https://twitter.com/iamdevloper/status/397664295875805184)
@@ -41,7 +41,7 @@ Here are some of the expectations we have of contributors:
- **[Squash](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) insignificant commits.** Every commit should be significant. Commits which merely rewrite a comment or fix a typo can be combined into another commit that has more substance. Interactive rebase can do this, or a simpler way is `git reset --soft <diverging-commit>` then `git commit -s`.
-- **Own your contributions.** Caddy is a growing project, and it's much better when individual contributors can help maintain their change after it is merged.
+- **Own your contributions.** Caddy is a growing project, and it's much better when individual contributors help maintain their change after it is merged.
- **Use comments properly.** We expect good godoc comments for package-level functions, types, and values. Comments are also useful whenever the purpose for a line of code is not obvious.