Merge pull request #33 from gkiar/update-docs

updated readme/basic docs

.github/CONTRIBUTING.md

@@ -0,0 +1,78 @@
+> This contributing guide is ***heavily*** based on the excellent guide used for the [Atom](https://github.com/atom/atom/blob/master/CONTRIBUTING.md) project.
+
+# Contributing to Fuzzy
+
+:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
+
+The following is a set of guidelines for contributing to Fuzzy and its images, which are hosted in the [Verificarlo Organization](https://github.com/verificarlo/) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the [Contributor Convenant Code of Conduct](https://www.contributor-covenant.org/). By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]](mailto:[email protected]).
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer: :computer:, and find related reports :mag_right:.
+
+Before creating bug reports, please perform a [cursory search of open issues](https://github.com/verificarlo/fuzzy/issues/) to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one. as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out an issue with the information requested in a template to help us resolve issues faster.
+
+> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
+
+#### How Do I Submit A (Good) Bug Report?
+
+Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue on this repository and provide the following information:
+
+* **Use a clear and descriptive title** for the issue to identify the problem.
+* **Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining how you started Fuzzy, e.g. which command exactly you used in the terminal. When listing steps, **don't just say what you did, but explain how you did it**.
+* **Provide specific examples to demonstrate the steps**. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
+* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
+* **Explain which behavior you expected to see instead and why.**
+* **If the problem is related to performance or memory**, include a detailed log of performance with and without using Fuzzy arithmetic backends with your report.
+
+Provide more context by answering these questions:
+
+* **Did the problem start happening recently** (e.g. after updating to a new version of Fuzzy) or was this always a problem?
+* If the problem started happening recently, **can you reproduce the problem in an older version of Fuzzy?** What's the most recent version in which the problem doesn't happen?
+* **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
+* **What's the name and version of the OS you're using**?
+* **Are you running Fuzzy in Docker or Singularity?** Which version of each are you using?
+
+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion for Fuzzy, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion :pencil: and find related suggestions :mag_right:.
+
+Before creating enhancement suggestions, please check perform a [cursory search of open issues](https://github.com/verificarlo/fuzzy/issues/) as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill in an issue including the steps that you imagine you would take if the feature you're requesting existed.
+
+#### How Do I Submit A (Good) Enhancement Suggestion?
+
+Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue provide the following information:
+
+* **Use a clear and descriptive title** for the issue to identify the suggestion.
+* **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
+* **Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples, as [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
+* **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
+* **Explain why this enhancement would be useful** to most Fuzzy users and is something that can or should be implemented.
+
+### Your First Code Contribution
+
+Unsure where to begin contributing to Atom? You can start by looking through these `beginner` and `help-wanted` issues:
+
+* [Beginner issues][beginner] - issues which should only require a few lines of code, and a test or two.
+* [Help wanted issues][help-wanted] - issues which should be a bit more involved than `beginner` issues.
+
+### Pull Requests
+
+The process described here has several goals:
+
+- Maintain Fuzzy's quality
+- Fix problems that are important to users
+- Enable a sustainable system for Fuzzy's maintainers to review contributions
+
+Please follow these steps to have your contribution considered by the maintainers:
+
+1. Follow all instructions in [the template](./github/PULL_REQUEST_TEMPLATE.md)
+2. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing. If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
+
+While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,10 @@
+<!--- Thank you for opening an issue! Please provide the following details to help the maintainers address your comments/concerns/suggestions. --->
+
+## Description of Issue/Feature Request
+<!--- A brief description of the error that is being encountered or the desired feature to be added --->
+
+## System Configuration
+<!--- Provide as much information as possible about your environment so that the issue may be reproduced, or the feature effectively added --->
+
+## Reproduction Instructions
+<!--- In the case of a bug report, please provide all of the details needed to reproduce this issue --->

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,27 +1,10 @@
 <!--
-Thanks for opening a PR!
+Thanks for opening a PR! Please fill in the following brief template to help the maintainers evaluate their contribution.
 
-To make sure that your build will proceed as expected, make sure that you
-set the following two environment variables on https://travis-ci.org/gkiar/fuzzy :
-
-  - DOCKER_USERNAME
-  - DOCKER_PASSWORD
-
-These should contain your personal credentials for Docker Hub, where the images will
-be pushed upon successful build. For instructions on how to set environment variables
-in Travis, you can consult the guide here:
-https://docs.travis-ci.com/user/environment-variables/#defining-variables-in-repository-settings
 -->
 
-| Property | Value |
-|:---------|:------|
-| Related Issues | <!-- List the issue(s) that are addressed by this PR --> |
-| Builds succeed |  Y/N |
-| If new image, created unit test | Y/N |
-
-## Purpose
+## Description of contribution
 <!--- A clear and concise description of what the PR does. -->
 
-## Implementation Detail
+## Implementation Details
 <!--- Provide a detailed description of the change or addition you are proposing -->
-