Skip to content

Commit 5f7b15d

Browse files
committed
Improve documentation
1 parent dbdf0ce commit 5f7b15d

File tree

2 files changed

+35
-24
lines changed

2 files changed

+35
-24
lines changed

.github/CONTRIBUTING.md

Lines changed: 30 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ community looks forward to your contributions. 🎉
1313
> the project and show your appreciation, which we would also be very happy about:
1414
> - Star the project
1515
> - Tweet about it
16-
> - Refer this project in your project's readme
16+
> - Refer to this project in your project's readme
1717
> - Mention the project at local meetups and tell your friends/colleagues
1818
1919
<!-- omit in toc -->
@@ -59,7 +59,7 @@ We will then take care of the issue as soon as possible.
5959
<!--
6060
You might want to create a separate issue tag for questions and include it in this description. People should then tag their issues accordingly.
6161
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:
6363
- IRC
6464
- Slack
6565
- Gitter
@@ -88,7 +88,7 @@ investigate carefully, collect information and describe the issue in detail in y
8888
following steps in advance to help us fix any potential bug as fast as possible.
8989

9090
- 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
9292
components/versions (Make sure that you have read
9393
the [documentation](https://github.com/dsoftwareinc/django-tasks-scheduler). If you are looking for support, you might
9494
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.
108108

109109
#### How Do I Submit a Good Bug Report?
110110

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
112112
> tracker, or elsewhere in public. Instead, sensitive bugs must be sent by email to <[email protected]>.
113113
<!-- You may add a PGP key to allow the messages to be sent encrypted as well. -->
114114
115115
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
116116

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.)
119120
- Explain the behavior you would expect and the actual behavior.
120121
- 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.
123124
- Provide the information you collected in the previous section.
124125

125126
Once it's filed:
@@ -135,7 +136,8 @@ Once it's filed:
135136

136137
### Suggesting Enhancements
137138

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
139141
features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the
140142
community to understand your suggestion and find related suggestions.
141143

@@ -146,7 +148,8 @@ community to understand your suggestion and find related suggestions.
146148
- Make sure that you are using the latest version.
147149
- Read the [documentation](https://github.com/dsoftwareinc/django-tasks-scheduler) carefully and find out if the
148150
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
150153
been suggested. If it has, add a comment to the existing issue instead of opening a new one.
151154
- 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
152155
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
168171
and Windows, and [this tool](https://github.com/colinkeenan/silentcast)
169172
or [this tool](https://github.com/GNOME/byzanz) on
170173
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
172176
other projects that solved it better and which could serve as inspiration.
173177

174178
<!-- 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. -->
175179

176180
### Your First Code Contribution
177181

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
183+
[help-wanted issues](https://github.com/dsoftwareinc/wiwik/labels/help%20wanted).
180184

181-
-->
185+
Never contributed to open source before? Here are a couple of friendly
186+
tutorials:
182187

183-
### Improving The Documentation
188+
- <http://makeapullrequest.com/>
189+
- <http://www.firsttimersonly.com/>
184190

185-
<!-- TODO
186-
Updating, improving and correcting the documentation
191+
### Improving The Documentation
187192

188-
-->
193+
- Create your own fork of the repository
194+
- Do the changes in your fork.
195+
- Create a pull request with the changes.
189196

190197
## Style guides
191198

@@ -201,15 +208,16 @@ Taken from [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/
201208
[optional footer(s)]
202209
```
203210

204-
The commit contains the following structural elements, to communicate intent to the consumers of your library:
211+
The commit message contains the following structural elements,
212+
in order to communicate intent to the consumers of your library:
205213

206214
* `fix:` a commit of the type fix patches a bug in your codebase (this correlates with `PATCH` in Semantic Versioning).
207215
* `feat:` a commit of the type feat introduces a new feature to the codebase (this correlates with `MINOR` in Semantic
208216
Versioning).
209217
* `BREAKING CHANGE:` a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a
210218
breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any
211219
type.
212-
* types other than `fix:` and `feat:` are allowed, for example @commitlint/config-conventional (based on the Angular
220+
* types other than `fix:` and `feat:` are allowed, for example, @commitlint/config-conventional (based on the Angular
213221
convention) recommends `build:`, `chore:`, `ci:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:`, and others.
214222
* footers other than `BREAKING CHANGE: <description>` may be provided and follow a convention similar to
215223
[git trailer format](https://git-scm.com/docs/git-interpret-trailers).
@@ -220,7 +228,8 @@ contextual information and is contained within parenthesis, e.g., feat(parser):
220228

221229
## Join The Project Team
222230

223-
<!-- TODO -->
231+
If you wish to be added to the project team as a collaborator, please create an issue
232+
explaining why you wish to join the team and tag @cunla in the issue.
224233

225234
<!-- omit in toc -->
226235

docs/installation.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,11 @@
6161

6262
4. Optional: Configure default values for queuing jobs from code:
6363
```python
64-
RQ = {
65-
'DEFAULT_RESULT_TTL': 360,
66-
'DEFAULT_TIMEOUT': 60,
64+
SCHEDULER_CONFIG = {
65+
'EXECUTIONS_IN_PAGE': 20,
66+
'DEFAULT_RESULT_TTL': 500,
67+
'DEFAULT_TIMEOUT': 300, # 5 minutes
68+
'SCHEDULER_INTERVAL': 10, # 10 seconds
6769
}
6870
```
6971

0 commit comments

Comments
 (0)