Skip to content

Commit 0e46250

Browse files
committed
Small improvements to CONTRIBUTING.md
Less passive voice, less difficult words. Some sentences read better now.
1 parent 880cf3d commit 0e46250

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

CONTRIBUTING.md

+12-13
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,26 @@ You can contribute in many ways to `matlab2tikz`:
88
- fix some of our bugs and implement new features.
99

1010
The first part of this document is geared more towards users of `matlab2tikz`.
11-
The latter part is relevant if you want to write some code for `matlab2tikz`.
11+
The latter part is only relevant if you want to write some code for `matlab2tikz`.
1212

1313
## How to report a bug or ask for help
1414

1515
1. Make sure you are using the [latest release](https://github.com/matlab2tikz/matlab2tikz/releases/latest) or even the [development version](https://github.com/matlab2tikz/matlab2tikz/tree/develop) of `matlab2tikz` and check that the problem still exists.
1616
2. Also make sure you are using a recent version of the required LaTeX packages (especially [`pgfplots`](http://ctan.org/pkg/pgfplots) and the [`TikZ`](http://ctan.org/pkg/pgf) libraries)
1717
3. You can submit your bug report or question to our [issue tracker](https://github.com/matlab2tikz/matlab2tikz/issues).
18-
Please, have a look at "[How to Ask Questions the Smart Way](http://www.catb.org/esr/faqs/smart-questions.html)" and "[Writing Better Bug Reports](http://martiancraft.com/blog/2014/07/good-bug-reports/)" for generic guidelines. Make sure you include the following things:
19-
- The version of MATLAB/Octave, the operating system, `matlab2tikz`, `pgfplots` and which `LaTeX` compiler you are using.
20-
- Choose a descriptive title.
18+
Please, have a look at "[How to Ask Questions the Smart Way](http://www.catb.org/esr/faqs/smart-questions.html)" and "[Writing Better Bug Reports](http://martiancraft.com/blog/2014/07/good-bug-reports/)" for generic guidelines. In short:
19+
- Mention the version of MATLAB/Octave, the operating system, `matlab2tikz`, `pgfplots` and which `LaTeX` compiler you are using.
20+
- Choose a descriptive title for your issue report.
2121
- A short MATLAB code snippet that generates a plot where the problem occurs. Please limit this to what is strictly necessary to show the issue!
22-
- Explain what is wrong with how the figure is converted (or what error messages you see).
22+
- Explain what is wrong with the conversion of the figure (or what error messages you see).
2323
- Often it can be useful to also include a figure, `TikZ` code, ... to illustrate your point.
2424

2525
## How to request new features
2626

2727
Please check first whether the feature hasn't been [requested](https://github.com/matlab2tikz/matlab2tikz/labels/feature%20request) before and do join the relevant topic in that case or maybe it has already been implemented in the [latest development version](https://github.com/matlab2tikz/matlab2tikz/tree/develop).
2828

29-
If your feature is something new and graphical, please also have a look at the [`pgfplots`](https://www.ctan.org/pkg/pgfplots) manual to see whether what you want is supported by this package.
30-
In some cases it is more constructive to request the feature for `pgfplots` in [their bug tracker](https://sourceforge.net/p/pgfplots/bugs/).
29+
If your feature is something new and graphical, please also have a look at the [`pgfplots`](https://www.ctan.org/pkg/pgfplots) manual to see if it supports the feature you want.
30+
In some cases it is more constructive to request the feature in the [`pgfplots` bug tracker](https://sourceforge.net/p/pgfplots/bugs/).
3131

3232
Please submit you feature request as any [bug report](https://github.com/matlab2tikz/matlab2tikz/labels/feature%20request) and make sure that you include enough details in your post, e.g.:
3333

@@ -43,23 +43,22 @@ To avoid wasted hours, please just indicate your interest to tackle the issue.
4343
[Our wiki](https://github.com/matlab2tikz/matlab2tikz/wiki/Recommended-git-workflow) contains more elaborate details on this process. Here is the gist:
4444

4545
- It is highly recommended to start a feature branch for your work.
46-
- Once you are finished with the work, please try to run the test suite and report on the outcome in your PR (see below).
46+
- Once you have finished the work, please try to run the test suite and report on the outcome in your PR (see below).
4747
- Make sure that you file your pull request against the `develop` branch and *not* the `master` branch!
4848
- Once you have filed your PR, the review process starts. Everybody is free to join this discussion.
49-
- Before a PR is pulled into `develop`, at least one other developer should review the code and signal their approval (often using a thumbs-up `:+1:` ).
50-
- After all comments have been addressed, a developer will merge your code into the `develop` branch.
49+
- At least one other developer will review the code and signal their approval (often using a thumbs-up, :+1:) before the PR gets pulled into `develop`.
50+
- Once you have addressed all comments, one of the developers will merge your code into the `develop` branch.
5151

5252
If you still feel uncomfortable with `git`, please have a look at [this page](https://github.com/matlab2tikz/matlab2tikz/wiki/Learning-git) for a quick start.
5353

5454
### Running the test suite
55-
We know that at first the test suite can seem a bit intimidating, so we tend to be very lenient during your first few PRs.
56-
However, we strongly recommend you run the test suite on your local computer and report on the results in your PR if any failures pop up.
55+
We know that at first the test suite can seem a bit intimidating, so we tend to be lenient during your first few PRs. However, we encourage you to run the test suite on your local computer and report on the results in your PR if any failures pop up.
5756
To run the test suite, please consult its [README](https://github.com/matlab2tikz/matlab2tikz/blob/develop/test/README.md).
5857

5958
## Becoming a member of [matlab2tikz](https://github.com/matlab2tikz)
6059

6160
Once you have submitted your first pull request that is of reasonable quality, you may get invited to join the [Associate Developers](https://github.com/orgs/matlab2tikz/teams/associate-developers) group.
62-
This group comes with *no* responsibility whatsoever and merely serves to make it easier for you to "claim" what features you want to work on.
61+
This group comes with *no* responsibility whatsoever and merely serves to make it easier for you to "claim" the features you want to work on.
6362

6463
Once you have gained some experience (with `git`/GitHub, our codebase, ...) and have contributed your fair share of great material, you will get invited to join the [Developers](https://github.com/orgs/matlab2tikz/teams/developers) team.
6564
This status gives you push access to our repository and hence comes with the responsibility to not abuse your push access.

0 commit comments

Comments
 (0)