docs: Added contributing tools

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+fg-feedback@protonmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,130 @@
+# Contributing to validate-python-headers
+
+Everything you need to know to contribute efficiently to the project!
+
+Whatever the way you wish to contribute to the project, please respect the [code of conduct](CODE_OF_CONDUCT.md).
+
+
+
+## Codebase structure
+
+- [src](https://github.com/frgfm/validate-python-headers/blob/main/src) - The actual script used for header verification
+- [action.yml](https://github.com/frgfm/validate-python-headers/blob/main/tests) - The marketplace action configuration file
+- [Dockerfile](https://github.com/frgfm/validate-python-headers/blob/main/Dockerfile) - The dockerfile of the action
+- [entrypoint.sh](https://github.com/frgfm/validate-python-headers/blob/main/entrypoint.sh) - The bash script executed by the Docker container
+
+
+## Continuous Integration
+
+This project uses the following integrations to ensure proper codebase maintenance:
+
+- [Github Worklow](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow) - run jobs for package build and coverage
+- [Codacy](https://www.codacy.com/) - analyzes commits for code quality
+
+As a contributor, you will only have to ensure coverage of your code by adding appropriate unit testing of your code.
+
+
+
+## Feedback
+
+### Feature requests & bug report
+
+Whether you encountered a problem, or you have a feature suggestion, your input has value and can be used by contributors to reference it in their developments. For this purpose, we advise you to use Github [issues](https://github.com/frgfm/validate-python-headers/issues). 
+
+First, check whether the topic wasn't already covered in an open / closed issue. If not, feel free to open a new one! When doing so, use issue templates whenever possible and provide enough information for other contributors to jump in.
+
+### Questions
+
+If you are wondering how to do something with this action, or a more general question, you should consider checking out Github [discussions](https://github.com/frgfm/validate-python-headers/discussions). See it as a Q&A forum, or the project-specific StackOverflow!
+
+
+
+## Submitting a Pull Request
+
+### Preparing your local branch
+
+1 - Fork this [repository](https://github.com/frgfm/validate-python-headers) by clicking on the "Fork" button at the top right of the page. This will create a copy of the project under your GitHub account (cf. [Fork a repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo)).
+
+2 - [Clone your fork](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) to your local disk and set the upstream to this repo
+```shell
+git clone git@github.com:<YOUR_GITHUB_ACCOUNT>/validate-python-headers.git
+cd validate-python-headers
+git remote add upstream https://github.com/frgfm/validate-python-headers.git
+```
+
+3 - You should not work on the `main` branch, so let's create a new one
+```shell
+git checkout -b a-short-description
+```
+
+4 - You only have to set your development environment now, using the following command:
+```shell
+make build
+```
+
+### Developing your feature
+
+#### Commits
+
+- **Code**: ensure to provide docstrings to your Python code. In doing so, please follow [Google-style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) so it can ease the process of documentation later.
+- **Commit message**: please follow [Udacity guide](http://udacity.github.io/git-styleguide/)
+
+#### Action sanity check
+
+In order to run the same checks as the CI workflows, you can run tests locally:
+
+```shell
+make test
+```
+
+#### Code quality
+
+To run all quality checks together
+
+```shell
+make quality
+```
+
+##### Lint verification
+
+To ensure that your incoming PR complies with the lint settings, you need to install [flake8](https://flake8.pycqa.org/en/latest/) and run the following command from the repository's root folder:
+
+```shell
+flake8 ./
+```
+This will read the `.flake8` setting file and let you know whether your commits need some adjustments.
+
+##### Import order
+
+In order to ensure there is a common import order convention, run [isort](https://github.com/PyCQA/isort) as follows:
+
+```shell
+isort .
+```
+This will reorder the imports of your local files.
+
+##### Annotation typing
+
+Additionally, to catch type-related issues and have a cleaner codebase, annotation typing are expected. After installing [mypy](https://github.com/python/mypy), you can run the verifications as follows:
+
+```shell
+mypy
+```
+The `pyproject.toml` file will be read to check your typing.
+
+##### Code formatting
+
+Finally, code formatting is a good practice for shareable projects. After installing [black](https://github.com/psf/black), you can run the verifications as follows:
+
+```shell
+black .
+```
+
+### Submit your modifications
+
+Push your last modifications to your remote branch
+```shell
+git push -u origin a-short-description
+```
+
+Then [open a Pull Request](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) from your fork's branch. Follow the instructions of the Pull Request template and then click on "Create a pull request".

Makefile

@@ -0,0 +1,20 @@
+# this target runs checks on all files
+quality:
+	isort . -c
+	flake8 ./
+	mypy
+	black --check .
+
+# this target runs checks on all files and potentially modifies some of them
+style:
+	isort .
+	black .
+
+# Build the docker image
+build:
+	docker build . -t header-validator:py3.8.13-alpine
+
+# Run tests for the library
+test:
+	docker build . -t header-validator:py3.8.13-alpine
+	docker run --workdir /github/workspace -v src:/github/workspace/src header-validator:py3.8.13-alpine Apache-2.0 'François-Guillaume Fernandez' 2022 src/ __init__.py

README.md

@@ -18,23 +18,23 @@ This action checks the copyright and license notices in the headers of your Pyth
 
 ## Inputs
 
-## `license`
+### `license`
 
 **Required** Identifier of the license for your project (cf. [SPDX identifiers](https://spdx.org/licenses/)).
 
-## `owner`
+### `owner`
 
 **Required** The copyright owner.
 
-## `starting-year`
+### `starting-year`
 
 **Required** The starting year of your project.
 
-## `folders`
+### `folders`
 
 The folders to inspect, separated by a comma. Default `"."`.
 
-## `ignores`
+### `ignores`
 
 The files to ignore, separated by a comma. Default `"__init__.py"`.
 
@@ -52,3 +52,16 @@ with:
   starting-year: 2022
   ignores: 'version.py,__init__.py'
 ```
+
+
+## Contributing
+
+Any sort of contribution is greatly appreciated!
+
+You can find a short guide in [`CONTRIBUTING`](CONTRIBUTING) to help grow this project!
+
+
+
+## License
+
+Distributed under the Apache 2.0 License. See [`LICENSE`](LICENSE) for more information.