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

chore: restructure and rewrite contributing.md to make it more clear

Browse Source
This commit is contained in:
neon_arch 2023-05-16 19:30:25 +03:00
parent 0b196ed3f2
commit 22638b88ca
1 changed files with 45 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
CONTRIBUTING.md
View File

@ -1,34 +1,56 @@
# Things to Consider Before Contributing
# What You Can Contribute To?
## Knowledge Required
## Documentation/Wiki
- 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
Found a typo, or something that isn't as clear as it could be? Maybe I've missed something off altogether, or you hit a roadblock that took you a while to figure out. Edit the [wiki](https://github.com/neon-mmd/websurfx/wiki) to add to or improve the documentation. This will help future users get Websurfx up and running more easily.
## Readme
Found a typo, or the Readme is not very clear as it should be?. Consider Submitting a Pull request to the [Readme](https://github.com/neon-mmd/websurfx/blob/master/README.md) to add to or improve the Readme. This will help future users to better understand the project more clearly.
## Source Code
You should know atleast one of the things below to start contributing:
- Rust basics
- Actix-web crate basics
- Tokio crate and async/await
- Reqwest crate basics
- Serde and serde_json crate basics
- Scraper crate basics
- Frontend (handlebars, css and js).
- Fake useragent crate basics
- pyo3/hlua/rlua crates basics
## Report a Bug/Issue
If you've found a bug, then please consider raising it as an issue [here](https://github.com/neon-mmd/websurfx/issues). This will help me know if there's something that needs fixing. Try and include as much detail as possible, such as your environment, steps to reproduce, any console output and maybe an example screenshot or recording if necessary.
## Spread the word
Websurfx is still a relatively young project, and as such not many people know of it. It would be great to see more users, and so it would be awesome if you could consider sharing with your friends or on social platforms.
## Guidelines
- Please be patient.
- 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.
- Treat everyone with respect -- \"give respect and take respect.\"
## Join the discussion
- Document your code properly with Rust coding conventions in mind.
We have a [Discord](https://discord.gg/SWnda7Mw5u) channel, feel free to join and share your ideas and ask questions about the project, we would be glad to hear you out.
- Provide a brief description of the changes you made in the pull
request.
# Where To Contribute?
- Provide an appropriate header for the pull request.
## For Source Code Contributions
The _rolling branch_ is where we intend all source code contributions should go.
**NOTE:** The rolling branch is where all contributions should go.
In other words, it is the working branch for this project.
## For Readme Contributions
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 and also if you have any
doubts/concerns/questions about the project, its source code or anything
related to the project than feel free to ask by opening an
\[issue\](<https://github.com/neon-mmd/websurfx/issues>).
The _master branch_ is where we intend all source code contributions should go.
We appreciate any contributions whether be of any size or topic and suggestions to help improve the Websurfx project. Please keep in mind the above requirements and guidelines before submitting a pull request and also if you have any doubts/concerns/questions about the project, its source code or anything related to the project than feel free to ask by opening an [issue](https://github.com/neon-mmd/websurfx/issues) or by asking us on our [Discord](https://discord.gg/SWnda7Mw5u) channel.