Skip to content

Commit

Permalink
Add Contributing doc
Browse files Browse the repository at this point in the history
  • Loading branch information
fluidnumerics-joe committed Jul 27, 2020
1 parent 522089b commit 8caa7e7
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Contributing to feqparse

## Reporting Issues
Issues, including bugs and feature requests, can be reported at https://github.com/FluidNumerics/feq-parse/issues

## Contributing
If you want to help resolve [any open issues](https://github.com/FluidNumerics/feq-parse/issues), you can do the following :

1. Fork this repository
2. Insert your fixes and commit your changes to your fork. Be sure to include any new additional tests to demonstrate the new feature or bug fix.
3. Open a pull request from your fork to this upstream repository.
4. Work with the upstream reviewer to merge your changes into feq-parse.

When you contribute code, feel add your name to the Contributors section of the README.md
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ Copyright 2020 Fluid Numerics LLC

`feqparse` is an equation parser Fortran class that is used to interpret and evaluate functions provided as strings.

[Learn how to contribute to this repository](./CONTRIBUTING.md)

## Installation

For a quick installation to `/usr/local/feqparse`,
Expand Down Expand Up @@ -75,3 +77,7 @@ IMPLICIT NONE
END PROGRAM FEqParseDemo
```

## Contributors

* (Maintainer) Joe Schoonover, Fluid Numerics LLC

0 comments on commit 8caa7e7

Please sign in to comment.