surfx / CONTRIBUTING.org
MD AL AMIN TALUKDAR
docs: Update CONTRIBUTING.org for clarity and organization
f2d1865 unverified
raw
history blame
871 Bytes
* 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
** Guidelines
- Please be patient.
- Treat everyone with respect -- "give respect and take respect."
- Document your code properly with Rust coding conventions in mind.
- Provide a brief description of the changes you made in the pull request.
- Provide an appropriate header for the pull request.
*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.