alamin/websurfx
alamin/websurfx
0
0
Fork 0
mirror of https://github.com/neon-mmd/websurfx.git synced 2024-11-21 13:38:21 -05:00
Code Issues Releases Activity

docs: Update CONTRIBUTING.org for clarity and organization

Browse Source 
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.
This commit is contained in:
MD AL AMIN TALUKDAR 2023-04-28 19:34:18 +05:30 committed by GitHub
parent 5ed87141ce
commit f2d1865d22
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
CONTRIBUTING.org
View File

@ -1,24 +1,26 @@
* Things to consider before contributing. * Things to Consider Before Contributing
** Knowledge Required ** Knowledge Required
- Rust basics. - Rust basics
- Actix-web crate basics. - Actix-web crate basics
- Tokio crate and async/await. - Tokio crate and async/await
- Reqwest crate basics. - Reqwest crate basics
- Serde and serde_json crate basics. - Serde and serde_json crate basics
- fake_useragent crate basics. - fake_useragent crate basics
- pyo3/hlua/rlua crates basics. - pyo3/hlua/rlua crates basics
** Guidelines ** Guidelines
- Please be patient. - 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.