Commit d05dac8d authored by Matthew Holt's avatar Matthew Holt

Little bit of housekeeping

parent 81e26970
...@@ -20,10 +20,10 @@ anything about Web development ...@@ -20,10 +20,10 @@ anything about Web development
### Bug reports ### Bug reports
First, please [search this repository](https://github.com/mholt/caddy/search?q=&type=Issues&utf8=%E2%9C%93) Please [search this repository](https://github.com/mholt/caddy/search?q=&type=Issues&utf8=%E2%9C%93)
with a variety of keywords to ensure your bug is not already reported. with a variety of keywords to ensure your bug is not already reported.
If not, [open an issue](https://github.com/mholt/caddy/issues) and answer the If unique, [open an issue](https://github.com/mholt/caddy/issues) and answer the
questions so we can understand and reproduce the problematic behavior. questions so we can understand and reproduce the problematic behavior.
The burden is on you to convince us that it is actually a bug in Caddy. This is The burden is on you to convince us that it is actually a bug in Caddy. This is
...@@ -39,12 +39,16 @@ getting free help. If we helped you, please consider ...@@ -39,12 +39,16 @@ getting free help. If we helped you, please consider
### Minor improvements and new tests ### Minor improvements and new tests
Submit [pull requests](https://github.com/mholt/caddy/pulls) at any time. Make Submit [pull requests](https://github.com/mholt/caddy/pulls) at any time for
sure to write tests to assert your change is working properly and is thoroughly minor changes or new tests. Make sure to write tests to assert your change is
covered. We'll ask most pull requests to be working properly and is thoroughly covered. We'll ask most pull requests to be
[squashed](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html), [squashed](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html),
especially with small commits. especially with small commits.
Your pull request may be thoroughly reviewed. This is because if we accept the
PR, we also assume responsibility for it, although we would prefer you to
help maintain your code after it gets merged.
### Proposals, suggestions, ideas, new features ### Proposals, suggestions, ideas, new features
...@@ -54,17 +58,23 @@ with a variety of keywords to ensure your suggestion/proposal is new. ...@@ -54,17 +58,23 @@ with a variety of keywords to ensure your suggestion/proposal is new.
If so, you may open either an issue or a pull request for discussion and If so, you may open either an issue or a pull request for discussion and
feedback. feedback.
The advantage of issues is that you don't have to spend time actually The advantage of issues is that you don't have to spend time implementing your
implementing your idea, but you should still describe it thoroughly. The idea, but you should still describe it thoroughly as if someone reading it would
advantage of a pull request is that we can immediately see the impact the change implement the whole thing starting from scratch.
will have on the project, what the code will look like, and how to improve it.
The disadvantage of pull requests is that they are unlikely to get accepted The advantage of pull requests is that we can immediately see the impact the
without significant changes, or it may be rejected entirely. Don't worry, that change will have on the project, what the code will look like, and how to
won't happen without an open discussion first. improve it. The disadvantage of pull requests is that they are unlikely to get
accepted without significant changes first, or it may be rejected entirely.
Don't worry, that won't happen without an open discussion first.
If you are going to spend significant time implementing code for a pull request, If you are going to spend significant time writing code for a new pull request,
best to open an issue first and "claim" it and get feedback before you invest best to open an issue to "claim" it and get feedback before you invest a lot of
a lot of time. time.
Remember: pull requests should always be thoroughly documented both via godoc
and with at least a rough draft of documentation that might go on the website
for users to read.
### Collaborator status ### Collaborator status
...@@ -75,6 +85,18 @@ push to the repository and merge other pull requests. We hope that you will ...@@ -75,6 +85,18 @@ push to the repository and merge other pull requests. We hope that you will
stay involved by reviewing pull requests, submitting more of your own, and stay involved by reviewing pull requests, submitting more of your own, and
resolving issues as you are able to. Thanks for making Caddy amazing! resolving issues as you are able to. Thanks for making Caddy amazing!
We ask that collaborators will conduct thorough code reviews and be nice to
new contributors. Before merging a PR, it's best to get the approval of
at least one or two other collaborators and/or the project owner. We prefer
squashed commits instead of many little, semantically-unimportant commits. Also,
CI and other post-commit hooks must pass before being merged except in certain
unusual circumstances.
Collaborator status may be removed for inactive users from time to time as
we see fit; this is not an insult, just a basic security precaution in case
the account becomes inactive or abandoned. Privileges can always be restored
later.
### Vulnerabilities ### Vulnerabilities
......
...@@ -18,3 +18,7 @@ ...@@ -18,3 +18,7 @@
#### 6. What did you see instead (give full error messages and/or log)? #### 6. What did you see instead (give full error messages and/or log)?
#### 7. How can someone who is starting from scratch reproduce this behavior as minimally as possible?
CHANGES CHANGES
<master>
- ...
0.8.3 (April 26, 2016) 0.8.3 (April 26, 2016)
- Built with Go 1.6.2 - Built with Go 1.6.2
- New pprof middleware for exposing process profiling endpoints - New pprof middleware for exposing process profiling endpoints
...@@ -17,6 +21,7 @@ CHANGES ...@@ -17,6 +21,7 @@ CHANGES
- tls: Session ticket keys are now rotated - tls: Session ticket keys are now rotated
- Many other minor internal improvements and bug fixes - Many other minor internal improvements and bug fixes
0.8.2 (February 25, 2016) 0.8.2 (February 25, 2016)
- On-demand TLS can obtain certificates during handshakes - On-demand TLS can obtain certificates during handshakes
- Built with Go 1.6 - Built with Go 1.6
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment