Skip to content

Update CONTRIBUTING.md #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
olivhoenen merged 1 commit into from
Jan 20, 2025
Merged

Update CONTRIBUTING.md #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 12 additions & 17 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down