From d0ca62482f3ccfe49bfdb5ce08136b46e6fba0d5 Mon Sep 17 00:00:00 2001 From: Maarten Sebregts <110895564+maarten-ic@users.noreply.github.com> Date: Mon, 20 Jan 2025 10:08:22 +0100 Subject: [PATCH] Update CONTRIBUTING.md Fix Markdown links: newlines inside a URL are not rendered properly --- CONTRIBUTING.md | 29 ++++++++++++----------------- 1 file changed, 12 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ac28e40..661eedb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,36 +7,31 @@ Please first make sure you read and follow the [Code of Conduct](CODE_OF_CONDUCT.md). ## You think you found a bug in the code, or have a question in its use -1. use the [issue search](https://github.com/iterorganization/ -imas-python/issues) to check if someone already created -a similar issue; -2. if not, make a **new issue** to describe your problem or question. +1. use the [issue search](https://github.com/iterorganization/imas-python/issues) +to check if someone already created a similar issue; +3. if not, make a **new issue** to describe your problem or question. In the case of a bug suspiscion, please try to give all the relevant information to allow reproducing the error or identifying its root cause (version of the imas-python, OS and relevant dependencies, snippet of code); -3. apply relevant labels to the issue. +4. apply relevant labels to the issue. ## You want to make or ask some change to the code -1. use the [issue search](https://github.com/iterorganization/ -imas-python/issues) to check if someone already proposed -a similar idea/change; -2. if not, create a **new issue** to describe what change you would like to see +1. use the [issue search](https://github.com/iterorganization/imas-python/issues) +to check if someone already proposed a similar idea/change; +3. if not, create a **new issue** to describe what change you would like to see implemented and specify it if you intend to work on it yourself or if some help will be needed; -3. wait until some kind of consensus is reached about your idea being relevant, +4. wait until some kind of consensus is reached about your idea being relevant, at which time the issue will be assigned (to you or someone else who can work on this topic); -4. if you do the development yourself, fork the repository to your own Github +5. if you do the development yourself, fork the repository to your own Github profile and create your own feature branch off of the latest develop commit. Make sure to regularly sync your branch with the latest commits from `develop` (find instructions -[here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/ -working-with-forks/syncing-a-fork); -5. when your development is ready, create a pull request (find instructions -[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)). +[here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork)); +6. when your development is ready, create a pull request (find instructions +[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)). While we will try to answer questions quickly and to address issues in a timely