diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e7cc141..26dc8dc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,23 +1,27 @@ # 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. -## 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. -## 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 - Actix-web crate basics - Tokio crate and async/await - Reqwest crate basics - Serde and serde_json crate basics -- Scraper crate basics +- Scraper crate basics - Frontend (handlebars, css and js). - Fake useragent crate 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? ## For Source Code Contributions - + The _rolling branch_ is where we intend all source code contributions should go. ## For Readme Contributions 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.