alamin/websurfx
alamin/websurfx
0
0
Fork 0
mirror of https://github.com/neon-mmd/websurfx.git synced 2024-11-24 23:18:22 -05:00
Code Issues Releases Activity

chore: add github actions

Browse Source
This commit is contained in:
neon_arch 2023-05-16 19:42:10 +03:00
parent 22638b88ca
commit 96f93e8074
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.md
View File

@ -1,23 +1,27 @@
# What You Can Contribute To? # What You Can Contribute To?
## Documentation/Wiki ## Documentation/Wiki
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. 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 ## 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. 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 ## Help Improve Github Actions
Know how to fix or improve a github action?. Consider Submitting a Pull request to help make automation and testing better.
## Source Code
You should know atleast one of the things below to start contributing:
You should know atleast one of the things below to start contributing:
- 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
- Scraper crate basics - Scraper crate basics
- Frontend (handlebars, css and js). - Frontend (handlebars, css and js).
- Fake useragent crate basics - Fake useragent crate basics
- pyo3/hlua/rlua crates basics - pyo3/hlua/rlua crates basics
@ -45,12 +49,11 @@ We have a [Discord](https://discord.gg/SWnda7Mw5u) channel, feel free to join an
# Where To Contribute? # Where To Contribute?
## For Source Code Contributions ## For Source Code Contributions
The _rolling branch_ is where we intend all source code contributions should go. The _rolling branch_ is where we intend all source code contributions should go.
## For Readme Contributions ## For Readme Contributions
The _master branch_ is where we intend all source code contributions should go. 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. 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.