Skip to content

Commit 784745b

Browse files
committed
docs: update contribution guidelines
1 parent 0a8dd5d commit 784745b

File tree

1 file changed

+9
-72
lines changed

1 file changed

+9
-72
lines changed

book/src/dev/CONTRIBUTE.md

Lines changed: 9 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ All types of contributions are encouraged and valued. See the [Table of Contents
77

88
> 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:
99
> - 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
1212
> - Mention the project at local meetups and tell your friends/colleagues
1313
1414
<!-- omit in toc -->
@@ -30,8 +30,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents
3030

3131
This project and everyone participating in it is governed by the
3232
[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.
3534

3635

3736
## I Have a Question
@@ -44,7 +43,7 @@ If you then still feel the need to ask a question and need clarification, we rec
4443

4544
- Open an [Issue](https://github.com/LeChatP/RootAsRole/issues/new).
4645
- 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.
4847

4948
We will then take care of the issue as soon as possible.
5049

@@ -75,77 +74,20 @@ Depending on how large the project is, you may want to outsource the questioning
7574

7675
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.
7776

78-
- Make sure that you are using the latest version.
77+
- Make sure that you are specified the version correctly.
7978
- 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)).
8079
- 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.
8280
- Collect information about the bug:
8381
- Stack trace (Traceback)
8482
- 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`)
8684
- Possibly your input and the output
8785
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
8886

8987
<!-- omit in toc -->
9088
#### How Do I Submit a Good Bug Report?
9189

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
93-
94-
```pgp
95-
-----BEGIN PGP PUBLIC KEY BLOCK-----
96-
97-
mQINBGN3U8UBEADbe0Wm75Ouew0WIIveLae8tWltIEvKr7rbCse8EHpDbWlESrGu
98-
tWo5SdIHDUu16YZyih1BrGRQ3AXnPJG/wmWP1Pz+vyMvwaHN0WWzhZS6b/24v0ai
99-
yLAXQUQCE02haTsn5mj8aMFP2dUhMQYsEYgjPcOJYhm5udxXJeYQAeZTcUnKjrji
100-
ECR3VErfjjW0SFsI4YkqhFpeOCcXhUR38NszpXPUZ9WcEgsvGB8N8nPqscEYQngI
101-
Xkk0WvJhkVmJk5NlPTUyhxhuxz7h4ADuYTnmbk5gZK3HKpmDXMVz0fQik6YKUNFv
102-
UowYA+QhLI892j62HTcBuCc8x9DB0kKTH/nuRjPYnX8tKyOPhgq9NKkOxSC4dOe9
103-
gTogSdhVA6TZvnbpssvBSz6WPYeIm/jfJdCEMbih2CteireTuyYLMCK2zstKFnnN
104-
GBrUVdFGdXwuxM5TJB5LotLQ/E/xxstGphGaHi+gKRLSiKV7wlFEhlgWB2l8RuWo
105-
F9KSOTm81mqCsMF6D4+on72uJV52Tumomc4eU8ESodHAsSiR9QkZ55BnnLu+Y8Wg
106-
b/axlTI1j2UV1ABxrqaxpb4V/z2DQNtnM/vNhuDi0maXHrUDHQRehwvTn/4mGsbA
107-
zXUMfOrFqCnh2QXXoCUSOVlgb2quLEJ2xQqr1j01yccPY/8iOC9I/0R0vwARAQAB
108-
tBxMZUNoYXRQIDxsZWNoYXRwQG91dGxvb2suZnI+iQJNBBMBCAA3FiEEdPQ8V3S+
109-
HzUn3vpINcFV6gUlEE0FAmN3U8cFCQWjmoACGwMECwkIBwUVCAkKCwUWAgMBAAAK
110-
CRA1wVXqBSUQTffYD/0Qi/WephoN7JjLEYMID2mBFfdE4Lz6uHjhSEcLAKIrEZF3
111-
VaNQa7sTug94j9Rkjdk6/GBk3SwHTAtRiTyw+ReNOW5LH3SbUO/we7quexPhZDON
112-
NbeJmCUX811okJL2av/52swE+MPYJNbn4BX3lWSzgN5fQZ9I/0QUm2yQnjq5vxar
113-
vbP144GW+ni9MvFYfcYZ6hSRpEhFlbJTJsJAZS4lTxkevg5ZdoIvMo63ZJ3CHTuN
114-
EfXmPvYxtKvo9h9ESQbMV2A++LDq4/JdBfBSQrXFJq8XL+75aQ7QkakiGp72DwTQ
115-
ds/MtAXe/3G2tjt7b/ytcNW4C8yPYiCbYdjBkS7aKIRF1XbRsgpARdOfCKsN/9Gu
116-
iIb/Oy2XqwLq0xTgl9wS9XldSX7sNVyM1DDRm6t1/cLWmqZCroApoIWpQX4SznRe
117-
3QCZ44eTHq+6b+eSiQZyrqaNDyVUdmXCTrQqXiotI7qQ00Hjigv6K2MInKGaN9Dw
118-
/nfGxBD3KJOVnTYzSTacB5vbS3NQv0nKBtg3wjaE5/l7Cq6ZQmd4SgGYX3F5wuuz
119-
jGtBmxe7gcZJzmodBLFflSbo0OFDmERcXyUls8jSEnbzRy8OVP2C2YOvXtxoL86g
120-
pq2pA+HJRzP6oso2EwXdE8HxBLoZ1tu2vgKv6xduEmkw14cvSeoVzrm8aWxXf7kC
121-
DQRjd1PHARAA14voBlK6KAaQ2oz+i1e9tiEUFFn5ZXxFdS4uH30Bttidugl1Ccdy
122-
AeTCSrG5WU/zPilttjjHG+KCBxdFGCVV+r7xYAtuVFfasKVSJyGqDZN6nI9MdKMA
123-
s3k7t9oz8RVvKWRpnLaxElvrE+k0n38t5LWQAyVrDeBQD0k0yneVZIc6OSaqANV6
124-
nuy4Z0LWsoC8EIfjIQ+Swx/OrhluwSMObChIh1QU6tZ+S6pp2mZl4hHlRnEA9Ivz
125-
LOZ2nB4IQ2SJL5jo5l9wFmzEseAsQPlSDowNNdPGik2b00UWfuMdM4BYjG140og9
126-
5FW87c0LzSYQZ66rmQqOb6c9tAMzjvaeCaaeFW8vIQP3/C1MXYiiLCFKTLg1vG9b
127-
sasT5nQVmq9ADjXf5uFk6UNKuXf0foUK5m8FTV5uvaZebekDPRUaEcuj8HSUaoER
128-
TIR59k5rm4Ha9/ZJTspAtv1pyCU/MwLPAWXc1e7Tl0yvnJz6s2/RB88YWd95YfN/
129-
h3pgKk8RaGkVKFv4bns7SIT4Ni4qxI1vqx07+t2CRQQOiqd9yXehAOsssQCI/p4a
130-
CIBjeeDxGjqpH6Nho5TlXywvzb50vez6b7P5F2iW5/owqEBn8Rz+LqUeUia9ChAT
131-
b7AAUeXeBhSq/xC8l3+bstvmTpcjW0kWLn+yovwTJCgB/eR7xALchPsAEQEAAYkC
132-
PAQYAQgAJhYhBHT0PFd0vh81J976SDXBVeoFJRBNBQJjd1PIBQkFo5qAAhsMAAoJ
133-
EDXBVeoFJRBNspQQAJK0m4gw3lFv0Vj3q5nIr8HcBn6L995BQwqvVrzAP/Bjl1xH
134-
s1YmBZoU6zydQybMP6lkh0STwXtzOlTsUxh454vrUp/CzB+Q6mJvXSCyN8gYZiqz
135-
q4GRNFx2Qppbui6Y+aMXoCtBv410wFxdE0U7i/+ZSf4U6cOi3y34QtBkicRdfPe/
136-
hb6pe8WAqfzdkv+20lC/aM9sPjdM9r9/KYU6JPZ2knG9T4IJHMXEoxuk/TDZgM5P
137-
Hl8pAY2LqN4ctbEclN0Z907baLkPBQDdbr38lD2H1isXsEZZxVuk8yoFOHyv2ey0
138-
amf60BVX/kZgAUO+8v+eMXM+TrQJlRVOj0Jk0qL5HUJZ1yfE1Dzv4OwrVdkGI5e4
139-
HGu7UgViAT5nQE7ATn7yoH31I00CWDfD1LPXrDsQeFsSYOJdfNFao+yPAYvE8XXL
140-
AIWocEDRE1ANDJ0rNclgpn4kUtvqbYqdWxW97Ba5+6d9dHFc4CnXHHv6WFoEFTCH
141-
RGufVgK54ynTLWi87jPoC371KOW3abjoWcsr5m57C2cil9nimjSTID+5w5zWXHip
142-
0hp8q7N1rChsvkmoU5ZFnF8QjmbLOM2VFIW7hnT5WfXWkSOJLjCExEQuYJEcL7YC
143-
nfacdGU6XXuJGhgFXCP7BYVQ5e8PlUowe/92T2NSPC7ZGCW0nsa3hH9wr8Jz
144-
=K6/W
145-
-----END PGP PUBLIC KEY BLOCK-----
146-
```
147-
148-
<!-- 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).
14991
15092
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
15193

@@ -160,8 +102,7 @@ Once it's filed:
160102
- 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.
161103
- 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).
162104

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.
165106

166107
### Suggesting Enhancements
167108

@@ -185,11 +126,7 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/LeChat
185126
- **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.
186127
- **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.
187128

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.
193130

194131
### Improving The Documentation
195132

0 commit comments

Comments
 (0)