114 lines
5.2 KiB
Markdown
Executable File
114 lines
5.2 KiB
Markdown
Executable File
# Contributing to this plugin
|
|
|
|
:+1: First, thanks for your desire make improvements to this plugin :+1:
|
|
|
|
Please take a moment to review this document in order to make the contribution
|
|
process easy and effective for everyone involved.
|
|
|
|
Following these guidelines helps to communicate that you respect the time of
|
|
the developers managing and developing this open source project. In return,
|
|
they should reciprocate that respect in addressing your issue or assessing
|
|
patches and features.
|
|
|
|
## Using the issue tracker
|
|
|
|
The issue tracker is the preferred channel for [bug reports](#bugs),
|
|
[features requests](#features) and [submitting pull
|
|
requests](#pull-requests), but please respect the following restrictions:
|
|
|
|
* Please **do not** use the issue tracker for issues related to GRAV.
|
|
Use the official Grav repo for that
|
|
|
|
<a name="bugs"></a>
|
|
## Bug reports
|
|
|
|
A bug is a _demonstrable problem_ that is caused by the code in the repository.
|
|
Good bug reports are extremely helpful - thank you!
|
|
|
|
Guidelines for bug reports:
|
|
|
|
1. **Check you satisfy the Grav requirements** — [http://learn.getgrav.org/basics/requirements](http://learn.getgrav.org/basics/requirements)
|
|
|
|
1. **Check this happens on a new Plugin install** — remove and re-install the plugin. Reset the plugin to its default configuration.
|
|
|
|
1. **Check this happens on a clean Grav install** — check if the issue happens on any Grav site, or just with a specific configuration of plugins / theme
|
|
|
|
1. **Use the GitHub issue search** — check if the issue has already been
|
|
reported.
|
|
|
|
1. **Check if the issue is already being solved in a PR** — check the open Pull Requests to see if one already solves the problem you're having
|
|
|
|
1. **Check if the issue has been fixed** — try to reproduce it using the
|
|
latest `develop` branch in the repository.
|
|
|
|
1. **Isolate the problem** — create a [reduced test
|
|
case](http://css-tricks.com/reduced-test-cases/) and provide a step-by-step instruction set on how to recreate the problem. Include code samples, page snippets or yaml configurations if needed.
|
|
|
|
A good bug report shouldn't leave others needing to chase you up for more
|
|
information. Please try to be as detailed as possible in your report.
|
|
|
|
What is your environment? Is it localhost, OSX, Linux, on a remote server? Same happening locally and or the server, or just locally or just on Linux?
|
|
|
|
What steps will reproduce the issue? What browser(s) and OS experience the problem?
|
|
|
|
What would you expect to be the outcome?
|
|
|
|
Did the problem start happening recently (e.g. after updating to a new version of this plugin) or was this always a problem?
|
|
|
|
If the problem started happening recently, can you reproduce the problem in an older version of this plugin ? What's the most recent version in which the problem doesn't happen? You can download older versions from the releases page on Github.
|
|
|
|
Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
|
|
|
|
|
|
All these details will help people to fix any potential bugs.
|
|
|
|
Important: [include Code Samples in triple backticks](https://help.github.com/articles/github-flavored-markdown/#fenced-code-blocks) so that Github will provide a proper indentation. [Add the language name after the backticks](https://help.github.com/articles/github-flavored-markdown/#syntax-highlighting) to add syntax highlighting to the code snippets.
|
|
|
|
Example:
|
|
|
|
> Short and descriptive example bug report title
|
|
>
|
|
> A summary of the issue and the browser/OS environment in which it occurs. If
|
|
> suitable, include the steps required to reproduce the bug.
|
|
>
|
|
> 1. This is the first step
|
|
> 2. This is the second step
|
|
> 3. Further steps, etc.
|
|
>>
|
|
> Any other information you want to share that is relevant to the issue being
|
|
> reported. This might include the lines of code that you have identified as
|
|
> causing the bug, and potential solutions (and your opinions on their
|
|
> merits).
|
|
|
|
|
|
<a name="features"></a>
|
|
## Feature requests
|
|
|
|
Feature requests are welcome. But take a moment to find out whether your idea
|
|
fits with the scope and aims of the project. It's up to *you* to make a strong
|
|
case to convince the project's developers of the merits of this feature. Please
|
|
provide as much detail and context as possible.
|
|
|
|
|
|
<a name="pull-requests"></a>
|
|
## Pull requests
|
|
|
|
Good pull requests - patches, improvements, new features - are a fantastic
|
|
help. They should remain focused in scope and avoid containing unrelated
|
|
commits.
|
|
|
|
Please adhere to the coding conventions used throughout the GRAV project (indentation,
|
|
accurate comments, etc.) and any other requirements.
|
|
**Please also respect the plugin specific conventions if any.**
|
|
|
|
See [Using Pull Request](https://help.github.com/articles/using-pull-requests/) and [Fork a Repo](https://help.github.com/articles/fork-a-repo/) if you're not familiar with Pull Requests.
|
|
|
|
Any pull request should be based on the `develop` branch. We will not consider pull requests made to master.
|
|
|
|
**IMPORTANT**: By submitting a patch, you agree to allow the project owner to
|
|
license your work under the same license as that used by the project.
|
|
|
|
<a name="translations"></a>
|
|
### Translations
|
|
Translations for this plugin are managed by direct request. Just send me an mail with your translation file.
|