You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: book/src/dev/CONTRIBUTE.md
+9-72Lines changed: 9 additions & 72 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,8 +7,8 @@ All types of contributions are encouraged and valued. See the [Table of Contents
7
7
8
8
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
9
9
> - Star the project
10
-
> -Tweet about it
11
-
> -Refer this project in your project's readme
10
+
> -Use `dosr` in your daily work
11
+
> -Document your scripts with `dosr` usage
12
12
> - Mention the project at local meetups and tell your friends/colleagues
13
13
14
14
<!-- omit in toc -->
@@ -30,8 +30,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents
30
30
31
31
This project and everyone participating in it is governed by the
32
32
[RootAsRole Code of Conduct](https://github.com/LeChatP/RootAsRoleblob/master/CODE_OF_CONDUCT.md).
33
-
By participating, you are expected to uphold this code. Please report unacceptable behavior
34
-
to .
33
+
By participating, you are expected to uphold this code. For now, we are too few to be able to enforce it.
35
34
36
35
37
36
## I Have a Question
@@ -44,7 +43,7 @@ If you then still feel the need to ask a question and need clarification, we rec
44
43
45
44
- Open an [Issue](https://github.com/LeChatP/RootAsRole/issues/new).
46
45
- Provide as much context as you can about what you're running into.
47
-
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
46
+
- Provide project and platform versions, depending on what seems relevant.
48
47
49
48
We will then take care of the issue as soon as possible.
50
49
@@ -75,77 +74,20 @@ Depending on how large the project is, you may want to outsource the questioning
75
74
76
75
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
77
76
78
-
- Make sure that you are using the latest version.
77
+
- Make sure that you are specified the version correctly.
79
78
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://lechatp.github.io/RootAsRole/). If you are looking for support, you might want to check [this section](#i-have-a-question)).
80
79
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/LeChatP/RootAsRoleissues?q=label%3Abug).
81
-
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
82
80
- Collect information about the bug:
83
81
- Stack trace (Traceback)
84
82
- OS, Platform and Version (Ubuntu 20.04, Debian 10, RedHat 8, etc.)
85
-
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
83
+
- Version of Rust (e.g. `rustc --version`)
86
84
- Possibly your input and the output
87
85
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
88
86
89
87
<!-- omit in toc -->
90
88
#### How Do I Submit a Good Bug Report?
91
89
92
-
> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <[email protected]> using the PGP key below
<!-- You may add a PGP key to allow the messages to be sent encrypted as well. -->
90
+
> For security issues, please read the [Security Policy](https://github.com/LeChatP/RootAsRole/blob/master/SECURITY.md).
149
91
150
92
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
151
93
@@ -160,8 +102,7 @@ Once it's filed:
160
102
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
161
103
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
162
104
163
-
<!-- You might want to create an issue template for bugs and errors that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
164
-
105
+
To help you to fill out the issue, please follow the templates provided by GitHub when you open a new issue.
165
106
166
107
### Suggesting Enhancements
167
108
@@ -185,11 +126,7 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/LeChat
185
126
-**Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
186
127
-**Explain why this enhancement would be useful** to most RootAsRole users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
187
128
188
-
<!-- You might want to create an issue template for enhancement suggestions that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
189
-
190
-
### Your First Code Contribution
191
-
192
-
129
+
Again, to help you to fill out the enhancement, please follow the templates provided by GitHub when you open a new issue.
0 commit comments