This repository has been archived by the owner on Dec 16, 2021. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
19 changed files
with
641 additions
and
121 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Contributing guidelines | ||
|
||
Tank you for your interest in the project. | ||
**Every contribution** to the project **is welcome**! | ||
|
||
## Issues | ||
|
||
Feel free to submit **issues**, **enhancement ideas** and **feature requests**. | ||
|
||
**Before submitting an issue**, please check if it has already been reported by checking the open issues. | ||
Try to be **as detailed as possible** when describing the encountered issue: | ||
|
||
* Precisely describe the bug: what is not working and how should it instead work? | ||
* Describe the **steps to reproduce the issue**. | ||
* **A code example** is often very helpful to better understand what is causing the problem. Provide it if possible. | ||
* Provide any extra information you consider important: device, browser and OS in use; other scripts and plugins in use etc.. | ||
|
||
## Contributing | ||
|
||
If you want to contribute to the project by submitting pull requests, please **open an issue in the issue tracker** to describe the bug(s) you are going to fix, or which extra feature(s) you are going to implement. If an issue is already open, please post a comment in the issue's thread. Before starting coding, **wait for a confirmation from the project's developers**. This will make sure you are not going to work on something which is already under development, or which will not be merged in the project. | ||
|
||
When developing code for the project: | ||
|
||
* **accurately comment** your code | ||
* adhere to the coding conventions used in the project | ||
|
||
**IMPORTANT: Pull requests must always contain a list of addressed issues in their descriptions.** | ||
|
||
|
||
## Copyright and Licensing | ||
|
||
The project is licensed under the terms of the **MIT license**. | ||
When contributing, you agree to allow the project owner to license your work under the same license as that used by the project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# ISSUE TITLE | ||
|
||
## Actual behaviour | ||
|
||
|
||
## Expected behaviour | ||
|
||
|
||
## Steps to reproduce the bug | ||
|
||
* Step 1 | ||
* Step 2 | ||
* ... | ||
|
||
## Code example (optional) | ||
|
||
## Relevant informations (browser, OS etc. - optional) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# PULL REQUEST TITLE | ||
|
||
## Fixes (or enhancements) proposed: | ||
|
||
* Fix issue #x | ||
* Fix issue #y | ||
* ... | ||
|
||
|
||
@DavideTriso |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.