mirror of
https://github.com/neon-mmd/websurfx.git
synced 2024-11-24 23:18:22 -05:00
71 lines
3.2 KiB
Markdown
71 lines
3.2 KiB
Markdown
# What You Can Contribute To?
|
|
|
|
## 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
|
|
|
|
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.
|
|
|
|
## 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:
|
|
|
|
- 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.
|
|
- 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.
|
|
|
|
## Join the discussion
|
|
|
|
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.
|
|
|
|
# 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.
|
|
|
|
# How To Fork
|
|
|
|
|
|
|
|
|
|
|
|
Please make sure to leave the `Copy the master branch only` option ticked off.
|
|
|
|
|
|
|
|
|
|
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.
|