Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sotillo19 authored Nov 26, 2017
1 parent 49b1adc commit dd9e057
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## How to contribute to JFML

#### **Did you find a bug?**

* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/sotillo19/JFML/issues).

* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/sotillo19/JFML/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.

#### **Did you write a patch that fixes a bug?**

* Open a new GitHub pull request with the patch.

* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

#### **Did you fix whitespace, format code, or make a purely cosmetic patch?**

Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of JFML will generally not be accepted. However, suggest your change in the [contact form](http://www.uco.es/JFML/about) in the associated website to [JFML](http://www.uco.es/JFML/) and we will respond to your request as soon as possible.

#### **Do you intend to add a new feature or change an existing one?**

* Suggest your change in the [contact form](http://www.uco.es/JFML/about) in the associated website to [JFML](http://www.uco.es/JFML/) and we will respond to your request as soon as possible.

* Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.

#### **Do you have questions about the source code?**

* Please read the documentation in [JFML Documentation](http://www.uco.es/JFML/documentation). You can find several examples and code.

* Ask any question about how to use JFML in the [contact form](http://www.uco.es/JFML/about) in the associated website to [JFML](http://www.uco.es/JFML/).

#### **Do you want to contribute to the JFML documentation?**

* Please read the documentation in [JFML Documentation](http://www.uco.es/JFML/documentation) and contact us via our [contact form](http://www.uco.es/JFML/about).


Thanks!

JFML Team

0 comments on commit dd9e057

Please sign in to comment.