forked from wrf-model/WRF
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Adds community guidelines/contributing etc. as requested in #23.
- Loading branch information
Showing
4 changed files
with
85 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**System information (please complete the following information):** | ||
- OS name and version: [e.g. Ubuntu 18, macOS 10.14, Windows 10] | ||
- Compiler name and version [e.g. gcc/gfortran 8.1, icc/ifort 19] | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request he |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# How to contribute | ||
|
||
Thank you for considering contributing to the WRF-CMake project. Please note that the aim of WRF-CMake is to bring CMake support to WRF and WPS therefore, any contributions made to this project should only consist of changes/fixes to issues related to building WRF or WPS with CMake support, pre-built binaries, Homebrew/Linuxbrew support, and Continuous Integration (CI) and testing. | ||
|
||
For any issues/contributions related with the WRF or WPS model, please see the [WRF](https://github.com/wrf-model/WRF) and [WPS](https://github.com/wrf-model/WPS) repositories directly. For any question/issues with the model physics please refer to the [WRF/WRFDA/WRF-Chem/MPAS Users' Support Forum](http://forum.mmm.ucar.edu/phpBB3/). | ||
|
||
In general, you can contribute by reporting an issue or by directly contributing to the source code. For the latter, fork our repository, clone the fork, make your changes, and create a pull request (PR) with a **clear description** of your changes -- if you are unfamiliar about forking/creating PR, please see [this guide](https://guides.github.com/activities/forking/) first. If/when your changes are merged, you will appear as a [Contributors](https://github.com/WRF-CMake/WRF/graphs/contributors). For specific instructions on how to report a bug or how to submit a feature request, please see below: | ||
|
||
- [Report a bug](#report-a-bug) | ||
- [Request a new feature](#request-a-new-feature) | ||
- [Coding conventions](#coding-conventions) | ||
- [Versioning](#versioning) | ||
|
||
|
||
If you would like to know more about specific development guidelines, please refer to our [development notes](DEVELOP.md). | ||
|
||
## Report a bug | ||
|
||
Before creating bug reports, please check if similar issue have already been reported [here](https://github.com/WRF-CMake/WRF/issues). If none exist please create a new issue and include as many details as possible using the required template. | ||
|
||
## Request a new feature | ||
|
||
Before creating a feature request, please check if a similar feature has been already asked [here](https://github.com/WRF-CMake/WRF/issues). If none exist please create a new feature request and include as many details as possible using the required template. | ||
|
||
## Coding conventions | ||
|
||
Same as in the [WRF](https://github.com/wrf-model/WRF) and [WPS](https://github.com/wrf-model/WPS). | ||
|
||
|
||
## Versioning | ||
|
||
WRF-CMake and WPS-CMake fully tracks releases made by the [WRF](https://github.com/wrf-model/WRF) and [WPS](https://github.com/wrf-model/WPS) model. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters