diff options
| author | Tobias Kunze <r@rixx.de> | 2019-06-17 16:54:55 +0200 |
|---|---|---|
| committer | Mariusz Felisiak <felisiak.mariusz@gmail.com> | 2019-09-06 13:27:46 +0200 |
| commit | 4a954cfd11a5d034491f87fcbc920eb97a302bb3 (patch) | |
| tree | 1c92caae5d8a9b33c51ddd74b4b2061248f3915f /docs/intro/contributing.txt | |
| parent | addabc492bdc0191ac95d59ec34b56b34086ebb9 (diff) | |
Fixed #30573 -- Rephrased documentation to avoid words that minimise the involved difficulty.
This patch does not remove all occurrences of the words in question.
Rather, I went through all of the occurrences of the words listed
below, and judged if they a) suggested the reader had some kind of
knowledge/experience, and b) if they added anything of value (including
tone of voice, etc). I left most of the words alone. I looked at the
following words:
- simply/simple
- easy/easier/easiest
- obvious
- just
- merely
- straightforward
- ridiculous
Thanks to Carlton Gibson for guidance on how to approach this issue, and
to Tim Bell for providing the idea. But the enormous lion's share of
thanks go to Adam Johnson for his patient and helpful review.
Diffstat (limited to 'docs/intro/contributing.txt')
| -rw-r--r-- | docs/intro/contributing.txt | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/intro/contributing.txt b/docs/intro/contributing.txt index 013f631f0a..b21ec57f6d 100644 --- a/docs/intro/contributing.txt +++ b/docs/intro/contributing.txt @@ -10,8 +10,9 @@ in Django that you'd like to see fixed, or maybe there's a small feature you want added. Contributing back to Django itself is the best way to see your own concerns -addressed. This may seem daunting at first, but it's really pretty simple. -We'll walk you through the entire process, so you can learn by example. +addressed. This may seem daunting at first, but it's a well-traveled path with +documentation, tooling, and a community to support you. We'll walk you through +the entire process, so you can learn by example. Who's this tutorial for? ------------------------ @@ -387,7 +388,7 @@ Running Django's test suite for the second time =============================================== Once you've verified that your patch and your test are working correctly, it's -a good idea to run the entire Django test suite just to verify that your change +a good idea to run the entire Django test suite to verify that your change hasn't introduced any bugs into other areas of Django. While successfully passing the entire test suite doesn't guarantee your code is bug free, it does help identify many bugs and regressions that might otherwise go unnoticed. @@ -592,7 +593,7 @@ If you just want to get started already (and nobody would blame you!), try taking a look at the list of `easy tickets that need patches`__ and the `easy tickets that have patches which need improvement`__. If you're familiar with writing tests, you can also look at the list of -`easy tickets that need tests`__. Just remember to follow the guidelines about +`easy tickets that need tests`__. Remember to follow the guidelines about claiming tickets that were mentioned in the link to Django's documentation on :doc:`claiming tickets and submitting patches </internals/contributing/writing-code/submitting-patches>`. |
