Skip to content
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.

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

Update CONTRIBUTING.md from master branch. #422

Merged
merged 1 commit into from
Feb 8, 2023
Merged
Changes from all commits
Commits
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
10 changes: 6 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,18 @@ A short presentation introducing the NorESM github repository, the issue and pul
https://github.com/NorESMhub/INES_workshop_2020/blob/gh-pages/files/Torsvik_gitcollaborate.pdf

# How to contribute
We recommend that you open an issue (https://github.com/NorESMhub/NorESM/issues) to discuss the changes or additions you want to include. This is done by selecting **New issue** in the top right corner of the issues page, and selecting one of the suggested issue types in the following menu. Through the issue discussion, you can work with the NorESM developers to implement the code changes in the correct repository and in the correct branch.
We recommend that you open a new [discussion item](https://github.com/NorESMhub/NorESM/issues) if you have questions about code contribution, or an [issue](https://github.com/NorESMhub/NorESM/issues) to discuss specific changes or additions you want to include. This is done by selecting **New issue** in the top right corner of the issues page, and selecting one of the suggested issue types in the following menu. Through the issue discussion, you can work with the NorESM developers to implement the code changes in the correct repository and in the correct branch.

# Who can contribute
Everybody with a github account can fork the repository, change a file and create a pull request, suggesting a change to the code or the documentation. The changes will, upon being merged by a member with write access, be visible to all. If you wish to have more access rights to any of the NorESMhub repositories, write to the NorESM team via email to noresm-ncc(at)met.no .

## Reporting bugs
Please, ensure that the bug was not already reported by searching on https://github.com/NorESMhub/NorESM/issues

If you find bugs, strange output or something puzzling, please raise an issue. No issue is too big nor too small. If you wrote code that fixes the bug, please see the description below.

## Suggesting Enhancements
If you want to submit an enhancement suggestion for NorESM, including completely new features, minor improvements to existing functionality or bug fixes, please read the NorESM documentation on how to contribute: https://noresm-docs.readthedocs.io/en/noresm2/contribute/contribute.html
If you want to submit an enhancement suggestion for NorESM, including completely new features, minor improvements to existing functionality or bug fixes, please read the [NorESM documentation on how to contribute](https://noresm-docs.readthedocs.io/en/noresm2/contribute/contribute.html):
You need to:
- Setup your personal NorESM fork in GitHub to put your developments
- Keep up to date with the NorESMhub.
Expand All @@ -25,7 +28,7 @@ You need to:

If your pull request causes conflicts which you are not able to resolve, please ask one of the NorESMhub maintainers for help.

If you introduce code changes or new features into NorESM, these need to be documented. Please remember to update the documentation as well.
If you introduce code changes or new features into NorESM, these need to be documented. Please remember to [update the documentation](https://github.com/NorESMhub/NorESM/blob/master/doc/README.md) as well.

## Do you have questions about the source code?
We recommend that you subscribe to the NorESM user mailing list: https://www.noresm.org/mailman/listinfo/users_noresm.org
Expand All @@ -36,4 +39,3 @@ https://noresm-docs.readthedocs.io/en/noresm2/index.html

### NorESM home page
https://www.noresm.org/