Skip to content

Commit 693f035

Browse files
maarten-icolivhoenen
authored andcommitted
Update CONTRIBUTING.md
Fix Markdown links: newlines inside a URL are not rendered properly
1 parent 6f871f5 commit 693f035

File tree

1 file changed

+12
-17
lines changed

1 file changed

+12
-17
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,36 +7,31 @@ Please first make sure you read and follow the
77
[Code of Conduct](CODE_OF_CONDUCT.md).
88

99
## You think you found a bug in the code, or have a question in its use
10-
1. use the [issue search](https://github.com/iterorganization/
11-
imas-python/issues) to check if someone already created
12-
a similar issue;
13-
2. if not, make a **new issue** to describe your problem or question.
10+
1. use the [issue search](https://github.com/iterorganization/imas-python/issues)
11+
to check if someone already created a similar issue;
12+
3. if not, make a **new issue** to describe your problem or question.
1413
In the case of a bug suspiscion, please try to give all the relevant
1514
information to allow reproducing the error or identifying
1615
its root cause (version of the imas-python, OS and relevant
1716
dependencies, snippet of code);
18-
3. apply relevant labels to the issue.
17+
4. apply relevant labels to the issue.
1918

2019
## You want to make or ask some change to the code
21-
1. use the [issue search](https://github.com/iterorganization/
22-
imas-python/issues) to check if someone already proposed
23-
a similar idea/change;
24-
2. if not, create a **new issue** to describe what change you would like to see
20+
1. use the [issue search](https://github.com/iterorganization/imas-python/issues)
21+
to check if someone already proposed a similar idea/change;
22+
3. if not, create a **new issue** to describe what change you would like to see
2523
implemented and specify it if you intend to work on it yourself or if some help
2624
will be needed;
27-
3. wait until some kind of consensus is reached about your idea being relevant,
25+
4. wait until some kind of consensus is reached about your idea being relevant,
2826
at which time the issue will be assigned (to you or someone else who can work on
2927
this topic);
30-
4. if you do the development yourself, fork the repository to your own Github
28+
5. if you do the development yourself, fork the repository to your own Github
3129
profile and create your own feature branch off of the latest develop commit.
3230
Make sure to regularly sync your branch with the latest commits from `develop`
3331
(find instructions
34-
[here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/
35-
working-with-forks/syncing-a-fork);
36-
5. when your development is ready, create a pull request (find instructions
37-
[here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/
38-
proposing-changes-to-your-work-with-pull-requests/
39-
creating-a-pull-request-from-a-fork)).
32+
[here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork));
33+
6. when your development is ready, create a pull request (find instructions
34+
[here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)).
4035

4136

4237
While we will try to answer questions quickly and to address issues in a timely

0 commit comments

Comments
 (0)