0
0
mirror of https://github.com/neon-mmd/websurfx.git synced 2024-12-22 20:38:22 -05:00
websurfx/CONTRIBUTING.org

27 lines
871 B
Org Mode
Raw Normal View History

* Things to Consider Before Contributing
2023-04-22 07:35:07 -04:00
** 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
2023-04-22 07:35:07 -04:00
** Guidelines
- Please be patient.
- Treat everyone with respect -- "give respect and take respect."
2023-04-22 07:35:07 -04:00
- Document your code properly with Rust coding conventions in mind.
2023-04-22 07:35:07 -04:00
- Provide a brief description of the changes you made in the pull request.
2023-04-22 07:35:07 -04:00
- Provide an appropriate header for the pull request.
2023-04-22 07:35:07 -04:00
*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.