diff --git a/CONTRIBUTING.org b/CONTRIBUTING.org index c543bd8..ba23501 100644 --- a/CONTRIBUTING.org +++ b/CONTRIBUTING.org @@ -1,24 +1,26 @@ -* Things to consider before contributing. +* Things to Consider Before Contributing ** Knowledge Required -- Rust basics. -- Actix-web crate basics. -- Tokio crate and async/await. -- Reqwest crate basics. -- Serde and serde_json crate basics. -- fake_useragent crate basics. -- pyo3/hlua/rlua crates basics. +- Rust basics +- Actix-web crate basics +- Tokio crate and async/await +- Reqwest crate basics +- Serde and serde_json crate basics +- fake_useragent crate basics +- pyo3/hlua/rlua crates basics ** Guidelines - Please be patient. -- Treat everyone with respect --- ("give respect and take respect"). +- Treat everyone with respect -- "give respect and take respect." -- Document your code properly with rust coding conventions in mind. +- Document your code properly with Rust coding conventions in mind. -- Provide a brief description of what changes you made in the pull request. +- Provide a brief description of the changes you made in the pull request. -- Provide an apropriate header to pull request. +- Provide an appropriate header for the pull request. - *NOTE:* The rolling branch is where all the contributions should go. In simple terms, it is the working branch for this project. + *NOTE:* The rolling branch is where all contributions should go. In other words, it is the working branch for this project. + +We appreciate any contributions and suggestions to help improve the Websurfx project. Please keep in mind the above requirements and guidelines before submitting a pull request.