feat: adding contribution tools (guide, templates for issues and PR) (jxmorris12#117)

mdevolde · Copilot · web-flow · commit cb964c516067 · 2025-11-08T00:17:30.000+01:00
* feat: adding contribution tools (guide, templates for issues and PR)

* fix (CONTRIBUTING.md): correcting spelling error

Co-authored-by: Copilot &lt;175728472+Copilot@users.noreply.github.com&gt;

* fix (pull_request_template.md): correcting spelling error

Co-authored-by: Copilot &lt;175728472+Copilot@users.noreply.github.com&gt;

* fix (CONTRIBUTING.md): correcting spelling error

Co-authored-by: Copilot &lt;175728472+Copilot@users.noreply.github.com&gt;

---------

Co-authored-by: Copilot &lt;175728472+Copilot@users.noreply.github.com&gt;
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,42 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: bug
+
+---
+
+# An appropriate title for your bug report, describing the issue in a few words
+
+## Describe the bug
+A clear and concise description of what the bug is.
+
+## To Reproduce
+Steps to reproduce the behavior:
+1. Installed x version
+2. Used this snippet
+3. ...
+
+## Observed behavior
+A clear and concise description of what actually happened.
+
+## Expected behavior
+A clear and concise description of what you expected to happen.
+
+## Screenshots
+If applicable, add screenshots to help explain your problem.
+
+## Execution environment (please complete the following information):
+ - OS: [e.g. Windows 11, Ubuntu 20.04]
+ - Python version [e.g. 3.9, 3.10]
+ - Package version [e.g. 2.9.5]
+ - Installed packages (run `pip list`)
+ - Installation method [e.g. pip, conda]
+
+## Logs/tracebacks
+```
+If applicable, add logs or tracebacks to help explain your problem.
+```
+
+## Additional context
+Add any other context about the problem here.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,34 @@
+# An appropriate title for your pull request, describing the change in a few words
+
+## Why the pull request was made
+Describe why the pull request was made, what problem it solves, and how it improves the project. 
+If there is an issue related to this pull request, please link it here.
+
+## Summary of changes
+Describe the changes made in the pull request, including any new features, bug fixes, or improvements.
+If applicable, include any relevant code snippets or examples to illustrate the changes.
+
+## Screenshots (if appropriate):
+If a screenshot is helpful to illustrate the changes, please include it here.
+
+## How has this been tested?
+Describe how the changes were tested, including any unit tests, integration tests, or manual testing performed.
+
+## Resources
+If applicable, include links to any relevant documentation, articles, or resources that provide additional context for the changes made in this pull request.
+
+## Types of changes
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update (changes to documentation only)
+- [ ] Refactor / code style update (non-breaking change that improves code structure or readability)
+- [ ] Tests / CI improvement (adding or updating tests or CI configuration only)
+- [ ] Other (please describe):
+
+## Checklist
+- [ ] Followed the [project's contributing guidelines](../CONTRIBUTING.md).
+- [ ] Updated any relevant tests.
+- [ ] Updated any relevant documentation.
+- [ ] Added comments to your code where necessary.
+- [ ] Formatted your code, run the linters and tests.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,77 @@
+# Contributing
+
+Thank you for thinking of making a contribution!
+
+## Pull Request Process
+
+### 0. Before you begin
+
+If this is your first time contributing to an open source project, [start by reading this guide](https://opensource.guide/how-to-contribute/#how-to-submit-a-contribution).
+
+Please note that any contribution you make will be licensed under [the project's license](https://github.com/jxmorris12/language_tool_python/blob/master/LICENSE).
+
+### 1. Find something to work on
+
+The best contributions are those that try to resolve the [issues](https://github.com/jxmorris12/language_tool_python/issues).
+
+### 2. Fork the repository and make your changes
+
+If you want to contribute, you first need to fork the repo (and preferably create a branch with a name that says something about the changes you're going to make).
+
+To start developing, you can install all the necessary packages in your python environment with this command (optional dependencies will be installed):
+```shell
+pip install -e .[dev]
+```
+
+When pushing commits, please use the project naming conventions, which are available in [this guide](https://www.conventionalcommits.org/en/v1.0.0/).
+If you haven't respected these conventions, do a rebase before making the pull request.
+
+The documentation style used in the project is **ReStructuredText**. Please, if you add or modify documentation, use this style. If you need more information or examples, look in the code, or in [this PEP](https://peps.python.org/pep-0287/) and [this guide](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html).
+
+Before creating your pull request, when you have made all your commits, you need to run this:
+```shell
+# Run linters (maybe you will have to fix some issues)
+ruff check language_tool_python tests
+
+# Format code
+black language_tool_python tests
+
+# Tests
+pytest
+```
+
+Please do not manually bump the version number in [pyproject.toml](./pyproject.toml), this will be handled by the maintainers during release.
+
+### 3. Checklist
+
+Before pushing and creating your pull request, you should make sure you've done the following:
+
+- Updated any relevant tests.
+- Updated any relevant documentation. This includes docstrings and [README](./README.md) file.
+- Added comments to your code where necessary (especially if the code is not self-explanatory).
+- Formatted your code, run the linters and tests.
+
+### 4. Create your pull request
+
+When you create your pull request, make sure you give it a name that clearly indicates what you have modified in the library.
+
+- Why the pull request was made
+- Summary of changes
+- If it resolves one or more issues, name them
+- If you have used external resources, mention them
+
+The best way to do this is to use the provided template when creating the pull request.
+
+### 5. Code review
+
+Your code will be reviewed by a maintainer.
+
+If you're not familiar with code review start by reading [this guide](https://google.github.io/eng-practices/review/).
+
+## Contacting the Maintainers
+
+As far as possible, communicate on github, in discussions on issues or pull requests.
+
+---
+
+Thank you for helping make **language_tool_python** better for everyone!
diff --git a/pyproject.toml b/pyproject.toml
@@ -8,6 +8,9 @@ license = { file = "LICENSE" }
 authors = [
     { name = "Jack Morris", email = "jxmorris12@gmail.com" }
 ]
+maintainers = [
+    { name = "mdevolde", email = "martin.devolder2@gmail.com" }
+]
 urls = { Repository = "https://github.com/jxmorris12/language_tool_python.git" }
 
 dependencies = [

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,9 @@ license = { file = "LICENSE" }`
`8`	`8`	`authors = [`
`9`	`9`	`{ name = "Jack Morris", email = "jxmorris12@gmail.com" }`
`10`	`10`	`]`
	`11`	`+maintainers = [`
	`12`	`+ { name = "mdevolde", email = "martin.devolder2@gmail.com" }`
	`13`	`+]`
`11`	`14`	`urls = { Repository = "https://github.com/jxmorris12/language_tool_python.git" }`
`12`	`15`
`13`	`16`	`dependencies = [`