tlsnotary/ws_stream_wasm
1
0
Fork 0
mirror of https://github.com/tlsnotary/ws_stream_wasm.git synced 2026-01-08 20:47:57 -05:00
Code Issues Packages Projects Releases Wiki Activity

improve contribution guidelines.

Browse Source
This commit is contained in:
Naja Melan
2020-12-02 16:47:07 +01:00
parent c5dfc76c20
commit dd8726dd6d
2 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@@ -1,9 +1,17 @@
# Contributing
This repository accepts contributions. Ideas, questions, feature requests and bug reports can be filed through Github issues.
Pull Requests are welcome on Github. By committing pull requests, you accept that your code might be modified and reformatted to fit the project coding style or to improve the implementation. Contributed code is considered licensed under the same license as the rest of the project unless explicitly agreed otherwise. See the `LICENCE` file.
Please discuss what you want to see modified before filing a pull request if you don't want to be doing work that might be rejected.
## Code formatting
I understand my code formatting style is quite uncommon, but it is deliberate and helps readability for me. Unfortunately, it cannot be achieved with automated tools like `rustfmt`. **Feel free to contribute code formatted however you are comfortable writing it**. I am happy to reformat during the review process. If you are uncomfortable reading my code, I suggest running `rustfmt` on the entire source tree or set your line-height to 1.2 instead of the common 1.5, which will make it look a lot less over the top.
# git workflow
Please file PR's against the `dev` branch, don't forget to update the changelog and the documentation.
Please file PR's against the `dev` branch, don't forget to update the documentation.

2
README.md
View File

@@ -188,7 +188,7 @@ otherwise only info and up level are reported.
### Code of conduct
Any of the behaviors described in [point 4 "Unacceptable Behavior" of the Citizens Code of Conduct](http://citizencodeofconduct.org/#unacceptable-behavior) are not welcome here and might get you banned. If anyone, including maintainers and moderators of the project, fail to respect these/your limits, you are entitled to call them out.
Any of the behaviors described in [point 4 "Unacceptable Behavior" of the Citizens Code of Conduct](https://github.com/stumpsyn/policies/blob/master/citizen_code_of_conduct.md#4-unacceptable-behavior) are not welcome here and might get you banned. If anyone, including maintainers and moderators of the project, fail to respect these/your limits, you are entitled to call them out.
## License