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: .github/CONTRIBUTING.md
+30-21Lines changed: 30 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ community looks forward to your contributions. 🎉
13
13
> the project and show your appreciation, which we would also be very happy about:
14
14
> - Star the project
15
15
> - Tweet about it
16
-
> - Refer this project in your project's readme
16
+
> - Refer to this project in your project's readme
17
17
> - Mention the project at local meetups and tell your friends/colleagues
18
18
19
19
<!-- omit in toc -->
@@ -59,7 +59,7 @@ We will then take care of the issue as soon as possible.
59
59
<!--
60
60
You might want to create a separate issue tag for questions and include it in this description. People should then tag their issues accordingly.
61
61
62
-
Depending on how large the project is, you may want to outsource the questioning, e.g. to Stack Overflow or Gitter. You may add additional contact and information possibilities:
62
+
Depending on how large the project is, you may want to outsource the questioning, e.g., to Stack Overflow or Gitter. You may add additional contact and information possibilities:
63
63
- IRC
64
64
- Slack
65
65
- Gitter
@@ -88,7 +88,7 @@ investigate carefully, collect information and describe the issue in detail in y
88
88
following steps in advance to help us fix any potential bug as fast as possible.
89
89
90
90
- Make sure that you are using the latest version.
91
-
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment
91
+
- Determine if your bug is really a bug and not an error on your side, e.g., using incompatible environment
92
92
components/versions (Make sure that you have read
93
93
the [documentation](https://github.com/dsoftwareinc/django-tasks-scheduler). If you are looking for support, you might
94
94
want to check [this section](#i-have-a-question)).
@@ -108,18 +108,19 @@ following steps in advance to help us fix any potential bug as fast as possible.
108
108
109
109
#### How Do I Submit a Good Bug Report?
110
110
111
-
> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue
111
+
> You must never report security related issues, vulnerabilities or bugs, including sensitive information to the issue
112
112
> tracker, or elsewhere in public. Instead, sensitive bugs must be sent by email to <[email protected]>.
113
113
<!-- You may add a PGP key to allow the messages to be sent encrypted as well. -->
114
114
115
115
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
116
116
117
-
- Open an [Issue](https://github.com/dsoftwareinc/django-tasks-scheduler/issues/new). (Since we can't be sure at this point
118
-
whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
117
+
- Open an [Issue](https://github.com/dsoftwareinc/django-tasks-scheduler/issues/new).
118
+
(Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and
119
+
not to label the issue.)
119
120
- Explain the behavior you would expect and the actual behavior.
120
121
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to
121
-
recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem
122
-
and create a reduced test case.
122
+
recreate the issue on their own. This usually includes your code.
123
+
For good bug reports, you should isolate the problem and create a reduced test case.
123
124
- Provide the information you collected in the previous section.
124
125
125
126
Once it's filed:
@@ -135,7 +136,8 @@ Once it's filed:
135
136
136
137
### Suggesting Enhancements
137
138
138
-
This section guides you through submitting an enhancement suggestion for django-tasks-scheduler, **including completely new
139
+
This section guides you through submitting an enhancement suggestion for django-tasks-scheduler, **including completely
140
+
new
139
141
features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the
140
142
community to understand your suggestion and find related suggestions.
141
143
@@ -146,7 +148,8 @@ community to understand your suggestion and find related suggestions.
146
148
- Make sure that you are using the latest version.
147
149
- Read the [documentation](https://github.com/dsoftwareinc/django-tasks-scheduler) carefully and find out if the
148
150
functionality is already covered, maybe by an individual configuration.
149
-
- Perform a [search](https://github.com/dsoftwareinc/django-tasks-scheduler/issues) to see if the enhancement has already
151
+
- Perform a [search](https://github.com/dsoftwareinc/django-tasks-scheduler/issues) to see if the enhancement has
152
+
already
150
153
been suggested. If it has, add a comment to the existing issue instead of opening a new one.
151
154
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to
152
155
convince the project's developers of the merits of this feature. Keep in mind that we want features that will be
@@ -168,24 +171,28 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/dsoftw
168
171
and Windows, and [this tool](https://github.com/colinkeenan/silentcast)
169
172
or [this tool](https://github.com/GNOME/byzanz) on
170
173
Linux. <!-- this should only be included if the project has a GUI -->
171
-
-**Explain why this enhancement would be useful** to most django-tasks-scheduler users. You may also want to point out the
174
+
-**Explain why this enhancement would be useful** to most django-tasks-scheduler users. You may also want to point out
175
+
the
172
176
other projects that solved it better and which could serve as inspiration.
173
177
174
178
<!-- 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. -->
175
179
176
180
### Your First Code Contribution
177
181
178
-
<!-- TODO
179
-
include Setup of env, IDE and typical getting started instructions?
182
+
Unsure where to begin contributing? You can start by looking through
0 commit comments