Skip to content

Commit

Permalink
Improve contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dunglas committed Oct 6, 2019
1 parent 7876be4 commit 51f037e
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 18 deletions.
18 changes: 0 additions & 18 deletions .github/CONTRIBUTING.md

This file was deleted.

17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Contributing

## License and Copyright Attribution

When you open a Pull Request to the project, you agree to license your code under the [GNU AFFERO GENERAL PUBLIC LICENSE](../LICENSE)
and to transfer the copyright on the submitted code to [Kévin Dunglas](https://dunglas.fr).

Be sure to you have the right to do that (if you are a professional, ask your company)!

If you include code from another project, please mention it in the Pull Request description and credit the original author.

## Hub

Clone the project:
Expand All @@ -25,6 +34,14 @@ To run the test suite:

$ go test -v -timeout 30s github.com/dunglas/mercure/hub

When you send a PR, just make sure that:

* You add valid test cases.
* Tests are green.
* You make a PR on the related documentation.
* You make the PR on the same branch you based your changes on. If you see commits
that you did not make in your PR, you're doing it wrong.

## Protocol

The protocol is written in Markdown, compatible with [Mmark](https://mmark.nl/).
Expand Down

0 comments on commit 51f037e

Please sign in to comment.