Skip to content

Commit

Permalink
Add a Contributor's Guide feature to the docs (#228)
Browse files Browse the repository at this point in the history
* create contributor's guide

* add guidelines for making good PR

* good pull request edits

* 1st Draft of COntributor's Guide

* minor formatting edits

* Add instructions for srw_common module load

* fix module files guidance

* fix typo

* update Intro & BuildRunSRW based on Mark's feedback

* minor intro updates

* add info on documentation requirements

* 1st round of J. Beck's edits

* add textonly issue template + minor typo-type fixes

* minor edits/formatting

* remove pylintrc requirement

* fixed .yaml & other minor

Co-authored-by: gspetro <gillian.s.petro@gmail.com>
  • Loading branch information
gspetro-NOAA and gspetro authored Apr 5, 2022
1 parent 2b09220 commit 57dc966
Show file tree
Hide file tree
Showing 3 changed files with 374 additions and 0 deletions.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/textonly_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Text-only request
about: Suggest an idea for this project
title: ''
labels: textonly
assignees: ''

---

## Description
Provide a clear and concise description of the problem to be solved.

## Solution
Add a clear and concise description of the proposed solution.

## Alternatives (optional)
If applicable, add a description of any alternative solutions or features you've considered.

## Related to (optional)
Directly reference any issues or PRs in this or other repositories that this is related to, and describe how they are related.
Loading

0 comments on commit 57dc966

Please sign in to comment.