Skip to content

Commit

Permalink
Add community guidelines/contributing. Fixes #23.
Browse files Browse the repository at this point in the history
  • Loading branch information
dmey committed Jun 10, 2019
1 parent 0961a30 commit 1264222
Show file tree
Hide file tree
Showing 4 changed files with 90 additions and 0 deletions.
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
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.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]

This comment has been minimized.

Copy link
@zbeekman

zbeekman Jun 11, 2019

You can run wrf on iOS?!

This comment has been minimized.

Copy link
@dmey

dmey Jun 11, 2019

Author

Oops -- fixed in b897780

- Browser [e.g. chrome, safari]

This comment has been minimized.

Copy link
@letmaik

letmaik Jun 11, 2019

Should be adapted to WRF. Maybe include compiler instead.

This comment has been minimized.

Copy link
@dmey

dmey Jun 11, 2019

Author

Fixed in 4e09c69

- Version [e.g. 22]

**Smartphone (please complete the following information):**

This comment has been minimized.

Copy link
@letmaik

letmaik Jun 11, 2019

Yeah... WRF on smartphones. Why not? :D

This comment has been minimized.

Copy link
@dmey

dmey Jun 11, 2019

Author

Fixed in 4e09c69

- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
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
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
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:https://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.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
- [Documentation](#documentation)
- [Example usage](#example-usage)
- [How to cite](#how-to-cite)
- [How to contribute](#how-to-contribute)
- [Testing framework](#testing-framework)
- [Changes to be upstreamed](#changes-to-be-upstreamed)
- [Copyright and license](#copyright-and-license)
Expand Down Expand Up @@ -106,6 +107,11 @@ Riechert and Meyer, 2019a: TODO
Riechert and Meyer, 2019b: TODO


## How to contribute

If you are looking to contribute, please read our Contributors' guide for details.

This comment has been minimized.

Copy link
@letmaik

letmaik Jun 11, 2019

Add link.

This comment has been minimized.

Copy link
@dmey

dmey Jun 11, 2019

Author

Fixed in 4e09c69



## Testing framework

In our current GitHub set-up, we perform a series of compilation and regression tests at each commit using the [WRF-CMake Automated Testing Suite](https://github.com/WRF-CMake/wats) on Windows, macOS, and Linux. You can find the results of such tests [here](https://travis-ci.com/WRF-CMake), [here](https://ci.appveyor.com/project/WRF-CMake/wrf), and [here](https://ci.appveyor.com/project/WRF-CMake/wps).
Expand Down

1 comment on commit 1264222

@zbeekman
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is certainly good enough for me.

If you want inspiration and/or to copy/clone others' issue/PR templates that may be more relevant to compiled desktop software, then I'd recommend exploring https://github.com/Homebrew/brew/tree/master/.github and the ISSUE_TEMPLATE subdirectory or https://github.com/sourceryinstitute/OpenCoarrays/tree/master/.github and the ISSUE_TEMPLATE directory.

But I'm satisfied either way 馃憤

Please sign in to comment.