neon_arch commited on
Commit
22638b8
1 Parent(s): 0b196ed

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

Browse files
Files changed (1) hide show
  1. CONTRIBUTING.md +45 -23
CONTRIBUTING.md CHANGED
@@ -1,34 +1,56 @@
1
- # Things to Consider Before Contributing
2
 
3
- ## Knowledge Required
4
 
5
- - Rust basics
6
- - Actix-web crate basics
7
- - Tokio crate and async/await
8
- - Reqwest crate basics
9
- - Serde and serde~json~ crate basics
10
- - fake~useragent~ crate basics
11
- - pyo3/hlua/rlua crates basics
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
12
 
13
  ## Guidelines
14
 
15
- - Please be patient.
 
 
 
 
 
 
 
 
16
 
17
- - Treat everyone with respect -- \"give respect and take respect.\"
18
 
19
- - Document your code properly with Rust coding conventions in mind.
 
 
20
 
21
- - Provide a brief description of the changes you made in the pull
22
- request.
23
 
24
- - Provide an appropriate header for the pull request.
25
 
26
- **NOTE:** The rolling branch is where all contributions should go.
27
- In other words, it is the working branch for this project.
28
 
29
- We appreciate any contributions and suggestions to help improve the
30
- Websurfx project. Please keep in mind the above requirements and
31
- guidelines before submitting a pull request and also if you have any
32
- doubts/concerns/questions about the project, its source code or anything
33
- related to the project than feel free to ask by opening an
34
- \[issue\](<https://github.com/neon-mmd/websurfx/issues>).
 
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
+ ## Source Code
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
24
+
25
+ ## Report a Bug/Issue
26
+
27
+ 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.
28
+
29
+ ## Spread the word
30
+
31
+ 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.
32
 
33
  ## Guidelines
34
 
35
+ - Please be patient.
36
+ - Treat everyone with respect -- \"give respect and take respect.\"
37
+ - Document your code properly with Rust coding conventions in mind.
38
+ - Provide a brief description of the changes you made in the pull request.
39
+ - Provide an appropriate header for the pull request.
40
+
41
+ ## Join the discussion
42
+
43
+ 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.
44
 
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.