Shorten CONTRIBUTING.md (#35)

* Shorten CONTRIBUTING.md
* autoformat markdown

.pre-commit-config.yaml

@@ -24,3 +24,12 @@ repos:
     hooks:
     - id: black
       exclude: ^.github/
+
+  - repo: https://github.com/executablebooks/mdformat
+    rev: 0.7.17
+    hooks:
+    - id: mdformat
+      args: ["--wrap", "79"]
+      exclude: ^doc/
+      additional_dependencies:
+      - mdformat-gfm

CHANGES.md

@@ -2,4 +2,4 @@
 
 ## v0.1.0
 
- - create project
+- create project

CONTRIBUTING.md

@@ -1,102 +1,31 @@
-# Contributing to fillname
+# Contributing
 
-First off, thanks for taking the time to contribute! ❤️
+Thanks for considering a contribution to fillname. ❤️
 
-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. 🎉
+## How to get help or discuss possible 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 (please don't bore your friends)
+To avoid duplicating issues, please search our [issue tracker][issues] and our
+[mailing list][mailing_list] before filing a new issue.
 
-<!-- omit in toc -->
-## Table of Contents
+- Open an [issue][new_issue] describing your problem.
+- [Subscribe] to our mailing list on SourceForge.
 
-- [Asking Question](#asking-questions)
-- [Contributing](#contributing)
-  - [Contributing Code](#contributing-code)
-  - [Reporting Bugs](#reporting-bugs)
-  - [Suggesting Enhancements](#suggesting-enhancements)
+## How to make a contribution
 
+- Fork the [fillname][project_url] repository and create a branch for your
+  changes.
+- Submit a pull request to the master branch with your changes.
+- Respond to feedback on your pull request.
+- If everything is fine your pull request is merged. 🥳
 
-## Asking Questions
+## License
 
-> If you want to ask a question, we assume that you have read the available [Documentation](https://fillname.org/).
+When contributing to this project, you 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.
 
-Before you ask a question, it is best to search for existing [issues](https://fillname.org/issues) or [messages](https://sourceforge.net/p/potassco/mailman/potassco-users/) in the archive of our mailing list.
-
-If you then still feel the need to ask a question and need clarification, we recommend the following:
-
-- [Subscribe](https://sourceforge.net/projects/potassco/lists/potassco-users) to our mailing list on SourceForge or open an [issue](https://fillname.org/issues/new) on GitHub.
-- Provide as much context as you can about what you're running into.
-- We can best help you if you provide executable code showcasing your problem.
-
-We will then take care of the issue as soon as possible.
-
-## Contributing
-
-> ### 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.
-
-### Contributing Code
-
-To contribute to fillname, please fork the repository and **open a pull request to the main branch**.
-Please use the coding style enforced by the precommit hook. To avoid unnecessary work, you can reach out to us to discuss your contribution via one of the ways described below.
-
-### 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. 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://fillname.org/issues?q=label%3Abug).
-- Collect information about the bug
-  - Python Version
-  - Possibly your input and the output
-  - Can you reliably reproduce the issue?
-  - Stack trace (Traceback)
-
-<!-- omit in toc -->
-#### How Do I Submit a Good Bug Report?
-
-We use GitHub issues to track bugs and errors. If you run into an issue with the project:
-
-- Open an [Issue](https://fillname.org/issues/new).
-- 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.
-- If the team is able to reproduce the issue, the issue will be left to be [implemented by someone](#your-first-code-contribution).
-
-### Suggesting Enhancements
-
-This section guides you through submitting an enhancement suggestion for fillname, **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://fillname.org/) carefully and find out if the functionality is already covered, maybe by an individual configuration.
-- Perform a [search](https://fillname.org/issues) to see if the enhancement has already been suggested. If it has, add a comment to an 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://fillname.org/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.
-- **Explain why this enhancement would be useful** and how it improves fillname.
-
-## Attribution
-This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!
+[issues]: https://fillname.org/issues/
+[mailing_list]: https://sourceforge.net/p/potassco/mailman/potassco-users/
+[new_issue]: https://fillname.org/issues/new/
+[project_url]: https://fillname.org/
+[subscribe]: https://sourceforge.net/projects/potassco/lists/potassco-users/

DEPLOYMENT.md

@@ -6,10 +6,10 @@ deploy test releases on [test.pypi].
 
 For this to work, the workflow has to be granted permission to deploy on the
 two services. Please follow this packaging [guide] to setup your accounts
-accordingly. We also recommend to setup a github [environment] to restrict which
-contributers can deploy packages.
+accordingly. We also recommend to setup a github [environment] to restrict
+which contributers can deploy packages.
 
+[environment]: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment/
+[guide]: https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
 [pypi]: https://pypi.org/
 [test.pypi]: https://test.pypi.org/
-[guide]: https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
-[environment]: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment/

DEVELOPMENT.md

@@ -22,9 +22,10 @@ nox -s session_name
 nox -Rs session_name
 ```
 
-Note that the nox sessions create [editable] installs. In case there are issues,
-try recreating environments by dropping the `-R` option. If your project is
-incompatible with editable installs, adjust the `noxfile.py` to disable them.
+Note that the nox sessions create [editable] installs. In case there are
+issues, try recreating environments by dropping the `-R` option. If your
+project is incompatible with editable installs, adjust the `noxfile.py` to
+disable them.
 
 We also provide a [pre-commit][pre] config to autoformat code upon commits. It
 can be set up using the following commands:
@@ -34,8 +35,7 @@ python -m pipx install pre-commit
 pre-commit install
 ```
 
+[editable]: https://setuptools.pypa.io/en/latest/userguide/development_mode.html
 [nox]: https://nox.thea.codes/en/stable/index.html
 [pipx]: https://pypa.github.io/pipx/
 [pre]: https://pre-commit.com/
-[editable]: https://setuptools.pypa.io/en/latest/userguide/development_mode.html
-

init.py

@@ -37,6 +37,7 @@ def git_config_get(attr):
     except subprocess.CalledProcessError:
         return None
 
+
 def main():
     """
     Rename the project.