<!-- omit in toc -->

# Contributing to PyFunceble

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
>
> - Star the project
> - Tweet about it
> - Refer this project in your project's readme
> - Mention the project at local meetups and tell your friends/colleagues

<!-- omit in toc -->

## Table of Contents

- [Contributing to PyFunceble](#contributing-to-pyfunceble)
  - [Table of Contents](#table-of-contents)
  - [Code of Conduct](#code-of-conduct)
  - [I Have a Question](#i-have-a-question)
  - [I Want To Contribute](#i-want-to-contribute)
    - [Reporting Bugs](#reporting-bugs)
      - [Before Submitting a Bug Report](#before-submitting-a-bug-report)
      - [How Do I Submit a Good Bug Report?](#how-do-i-submit-a-good-bug-report)
    - [Suggesting Enhancements](#suggesting-enhancements)
      - [Before Submitting an Enhancement](#before-submitting-an-enhancement)
      - [How Do I Submit a Good Enhancement Suggestion?](#how-do-i-submit-a-good-enhancement-suggestion)
    - [Your First Code Contribution](#your-first-code-contribution)
      - [Notes for Code Contributions](#notes-for-code-contributions)
    - [Improving The Documentation](#improving-the-documentation)
  - [Styleguides](#styleguides)
    - [Code Format](#code-format)
    - [Code Linting](#code-linting)
    - [Tests Coverage](#tests-coverage)
    - [Commit Messages](#commit-messages)
  - [Attribution](#attribution)

## Code of Conduct

This project and everyone participating in it is governed by the
[PyFunceble Code of Conduct](https://github.com/funilrys/PyFuncebleblob/dev/CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code. Please report unacceptable behavior
to <contact@funilrys.com>.

## I Have a Question

> If you want to ask a question, we assume that you have read the available [Documentation](https://docs.pyfunceble.com).

Before you ask a question, it is best to search for existing [Issues](https://github.com/funilrys/PyFunceble/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

- Open an [Issue](https://github.com/funilrys/PyFunceble/issues/new).
- Provide as much context as you can about what you're running into.
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.

We will then take care of the issue as soon as possible.

<!--
You might want to create a separate issue tag for questions and include it in this description. People should then tag their issues accordingly.

Depending on how large the project is, you may want to outsource the questioning, e.g. to Stack Overflow or Gitter. You may add additional contact and information possibilities:
- IRC
- Slack
- Gitter
- Stack Overflow tag
- Blog
- FAQ
- Roadmap
- E-Mail List
- Forum
-->

## I Want To Contribute

> ### Legal Notice <!-- omit in toc -->
>
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.

### Reporting Bugs

<!-- omit in toc -->

#### Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

- Make sure that you are using the latest version.
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://docs.pyfunceble.com). If you are looking for support, you might want to check [this section](#i-have-a-question)).
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/funilrys/PyFunceble/issues?q=label%3Abug).
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
- Collect information about the bug:
- Stack trace (Traceback)
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
- Possibly your input and the output
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?

<!-- omit in toc -->

#### How Do I Submit a Good Bug Report?

> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to .

<!-- You may add a PGP key to allow the messages to be sent encrypted as well. -->

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

- Open an [Issue](https://github.com/funilrys/PyFunceble/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
- Explain the behavior you would expect and the actual behavior.
- Please provide as much context as possible and describe the _reproduction steps_ that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
- Provide the information you collected in the previous section.

Once it's filed:

- The project team will label the issue accordingly.
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).

<!-- You might want to create an issue template for bugs and errors that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->

### Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for PyFunceble, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

<!-- omit in toc -->

#### Before Submitting an Enhancement

- Make sure that you are using the latest version.
- Read the [documentation](https://docs.pyfunceble.com) carefully and find out if the functionality is already covered, maybe by an individual configuration.
- Perform a [search](https://github.com/funilrys/PyFunceble/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
- 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. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.

<!-- omit in toc -->

#### How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as [GitHub issues](https://github.com/funilrys/PyFunceble/issues).

- 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.
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. <!-- this should only be included if the project has a GUI -->
- **Explain why this enhancement would be useful** to most PyFunceble users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

<!-- You might want to create an issue template for enhancement suggestions that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->

### Your First Code Contribution

<!-- TODO
include Setup of env, IDE and typical getting started instructions?

-->

We do not any constraint regarding the way to use or configure your IDE.
But, we compiled some of the necessary steps that you may need before starting to
hack PyFunceble.

1. If you haven't already: Clone or Fork the repository.
2. Create a new branch for your change.
3. Create a virtual environment (recommended)

   ```shell
   virtualenv -p python3 venv
   . venv/bin/activate
   ```

4. Install the development related dependencies.

   ```shell
   # Assuming you activated the environment.
   pip3 install -e .[dev,test]

   ```

5. Test if pyfunceble is running.

   ```shell
   pyfunceble --version
   ```

6. Test if tests are running.

   ```shell
   tox
   ```

Once you went through all of those steps, you are ready and can start to code.

#### Notes for Code Contributions

1. When you are working on a new feature or a bug, make sure to create a new branch.
2. When developing, please keep in mind that your configuration files located in the `~/.config/pyfunceble/` directory will be ignored.

   Therefore, you may want to create a new configuration file in the root of the repository. You can overwrite it by using the `PYFUNCEBLE_CONFIG_DIR` environment variable.

### Improving The Documentation

Maintaining a documentation is rarely a one man action. If you think a paragraph,
a section should be improved or a totally new section added, feel free to write
a draft and submit your change through a Pull Request.

If you want to test your changes locally, some steps are necessary:

1. If you haven't already: Clone or Fork the repository.
2. Create a new branch for your change.
3. Create a virtual environment (recommended)

   ```shell
   virtualenv -p python3 venv
   . venv/bin/activate
   ```

4. Install the docs related dependencies.

   ```shell
   # Assuming you activated the environment.
   pip3 install -e .[docs]
   ```

5. Serve the documentation for live testing:

   ```shell
   mkdocs serve
   ```

Once you went through all of those steps, you are ready and can start editing the
documentation.

## Styleguides

### Code Format

We love unique contributions, but we hate to deal with serveral code formats.
Therefore, we adopted [Black](https://github.com/ambv/black),
_The uncompromising Python code formatter_, to format our code.

No more headache or thinking, just apply the `black` command against your change
and you are good to go!

### Code Linting

We are human and we sometime make mistakes. One way to reduce issues before a
change hits a global deployment is through linting.

To reduce headeche, the repository is already configured!

You can lint your code before commiting them by running `pylint` against your
modified files.

### Tests Coverage

We want to have a code test coverage of at lease 60%.
Therefore, be sure to run `tox` before commiting your changes!

### Commit Messages

Your git message should be consice but informative.
Therefore, we ask you the follow the following convention:

```
[Verb] [Description]

Paragraphs with some details/context (if needed).
```

<!-- ## Join The Project Team -->
<!-- TODO -->

<!-- omit in toc -->

## Attribution

This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!