mirror of
https://github.com/neon-mmd/websurfx.git
synced 2024-12-22 20:38:22 -05:00
f2d1865d22
This commit updates the CONTRIBUTING.org file for the Websurfx project to improve its clarity and organization. The changes were made to ensure that contributors have a clear understanding of the project's requirements and guidelines. The changes include reorganizing the existing guidelines to improve their flow and readability, and clarifying the requirements for contributing to the project. Additionally, the formatting has been adjusted to ensure consistency and improve readability.
27 lines
871 B
Org Mode
27 lines
871 B
Org Mode
* 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.
|