neon_arch
commited on
Commit
•
96f93e8
1
Parent(s):
22638b8
chore: add github actions
Browse files- CONTRIBUTING.md +11 -8
CONTRIBUTING.md
CHANGED
|
@@ -1,23 +1,27 @@
|
|
| 1 |
# What You Can Contribute To?
|
| 2 |
|
| 3 |
-
## Documentation/Wiki
|
| 4 |
|
| 5 |
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.
|
| 6 |
|
| 7 |
-
## Readme
|
| 8 |
|
| 9 |
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.
|
| 10 |
|
| 11 |
-
##
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 12 |
|
| 13 |
-
You should know atleast one of the things below to start contributing:
|
| 14 |
-
|
| 15 |
- Rust basics
|
| 16 |
- Actix-web crate basics
|
| 17 |
- Tokio crate and async/await
|
| 18 |
- Reqwest crate basics
|
| 19 |
- Serde and serde_json crate basics
|
| 20 |
-
- Scraper crate basics
|
| 21 |
- Frontend (handlebars, css and js).
|
| 22 |
- Fake useragent crate basics
|
| 23 |
- pyo3/hlua/rlua crates basics
|
|
@@ -45,12 +49,11 @@ We have a [Discord](https://discord.gg/SWnda7Mw5u) channel, feel free to join an
|
|
| 45 |
# Where To Contribute?
|
| 46 |
|
| 47 |
## For Source Code Contributions
|
| 48 |
-
|
| 49 |
The _rolling branch_ is where we intend all source code contributions should go.
|
| 50 |
|
| 51 |
## For Readme Contributions
|
| 52 |
|
| 53 |
The _master branch_ is where we intend all source code contributions should go.
|
| 54 |
|
| 55 |
-
|
| 56 |
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.
|
|
|
|
| 1 |
# What You Can Contribute To?
|
| 2 |
|
| 3 |
+
## Documentation/Wiki
|
| 4 |
|
| 5 |
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.
|
| 6 |
|
| 7 |
+
## Readme
|
| 8 |
|
| 9 |
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.
|
| 10 |
|
| 11 |
+
## Help Improve Github Actions
|
| 12 |
+
|
| 13 |
+
Know how to fix or improve a github action?. Consider Submitting a Pull request to help make automation and testing better.
|
| 14 |
+
|
| 15 |
+
## Source Code
|
| 16 |
+
|
| 17 |
+
You should know atleast one of the things below to start contributing:
|
| 18 |
|
|
|
|
|
|
|
| 19 |
- Rust basics
|
| 20 |
- Actix-web crate basics
|
| 21 |
- Tokio crate and async/await
|
| 22 |
- Reqwest crate basics
|
| 23 |
- Serde and serde_json crate basics
|
| 24 |
+
- Scraper crate basics
|
| 25 |
- Frontend (handlebars, css and js).
|
| 26 |
- Fake useragent crate basics
|
| 27 |
- pyo3/hlua/rlua crates basics
|
|
|
|
| 49 |
# Where To Contribute?
|
| 50 |
|
| 51 |
## For Source Code Contributions
|
| 52 |
+
|
| 53 |
The _rolling branch_ is where we intend all source code contributions should go.
|
| 54 |
|
| 55 |
## For Readme Contributions
|
| 56 |
|
| 57 |
The _master branch_ is where we intend all source code contributions should go.
|
| 58 |
|
|
|
|
| 59 |
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.
|