Improved documentation

.gitignore

@@ -62,6 +62,9 @@ cover/
 *.mo
 *.pot
 
+# Ruff
+.ruff_cache/
+
 # Django stuff:
 *.log
 local_settings.py

CODE_OF_CONDUCT.md

@@ -0,0 +1,71 @@
+# Code of Conduct - Bump My Version
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, 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.
+
+## 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
+- 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
+
+## Our Responsibilities
+
+Project maintainers 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.
+
+Project maintainers 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. 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](https://contributor-covenant.org/), version [1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and [2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md, and was generated by [contributing-gen](https://github.com/bttger/contributing-gen).

CONTRIBUTING.md

@@ -1,10 +1,118 @@
-# Contributing
+# Contributing to Bump My Version
 
-## Getting started with development
+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 much easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
+
+> If you like the project but 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 to this project in your project's readme
+> - Mention the project at local meetups and tell your friends/colleagues
+
+## Table of Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [I Have a Question](#i-have-a-question)
+- [Reporting Bugs](#reporting-bugs)
+- [Suggesting Enhancements](#suggesting-enhancements)
+- [Your First Code Contribution](#your-first-code-contribution)
+- [Improving The Documentation](#improving-the-documentation)
+- [Styleguides](#styleguides)
+- [Commit Messages](#commit-messages)
+- [Join The Project Team](#join-the-project-team)
+
+
+## Code of Conduct
+
+This project and everyone participating in it are governed by the
+[Bump My Version Code of Conduct](https://github.com/callowayproject/bump-my-versionblob/master/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior
+to <coreyoordt@gmail.com>.
+
+
+## I Have a Question
+
+> If you want to ask a question, we assume that you have read the available [Documentation](https://callowayproject.github.io/bump-my-version/).
+
+Before you ask a question, it is best to search for existing [Issues](https://github.com/callowayproject/bump-my-version/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/callowayproject/bump-my-version/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.
+
+## Reporting Bugs
+
+### 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://callowayproject.github.io/bump-my-version/). 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/callowayproject/bump-my-version/issues).
+- 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)
+  - The version of Python
+  - Possibly your input and the output
+  - Can you reliably reproduce the issue? And can you also reproduce it with older versions?
+
+
+### How Do I Submit a Good Bug Report?
+
+> You must never report security-related issues, vulnerabilities, or bugs that include sensitive information to the issue tracker or elsewhere in public. Instead, sensitive bugs must be sent by email to <coreyoordt@gmail.com>.
+
+We use GitHub issues to track bugs and errors. If you run into an issue with the project:
+
+- Open an [Issue](https://github.com/callowayproject/bump-my-version/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 will not address them until they are included.
+- 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 Bump My Version, **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.
+
+### Before Submitting an Enhancement
+
+- Make sure that you are using the latest version.
+- Read the [documentation](https://callowayproject.github.io/bump-my-version/) carefully and find out if the functionality is already covered, maybe by an individual configuration.
+- Perform a [search](https://github.com/callowayproject/bump-my-version/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.
+
+### How Do I Submit a Good Enhancement Suggestion?
+
+Enhancement suggestions are tracked as [GitHub issues](https://github.com/callowayproject/bump-my-version/issues).
+
+- Use a **clear and descriptive title** for the issue to identify the suggestion.
+- **Describe the problem or use case** this enhancement solves **or the new benefit** it provides.
+- **Explain why this enhancement would be useful** to most Bump My Version users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
+- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
+- You may also tell how current alternatives do not work for you, if appropriate
+
+<!-- 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
+
+
+> ### Legal Notice
+>
+> 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.
 
 ### Setup
 
-There are several ways to create your isolated environment. This is the default method.
+There are several ways to create an isolated Python development environment. This is the [default method](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment).
 
 Run the following in a terminal:
 
@@ -15,9 +123,9 @@ git clone https://github.com/callowayproject/bump-my-version.git
 # Enter the repository
 cd bump-my-version
 
-# Create then activate a virtual environment
-python -m venv venv
-source venv/bin/activate
+# Create, then activate a virtual environment
+python -m venv env
+source env/bin/activate
 
 # Install the development requirements
 python -m pip install -r requirements/dev.txt
@@ -31,10 +139,79 @@ Once setup, you should be able to run tests:
 pytest
 ```
 
-## Install Pre-commit Hooks
+### Install Pre-commit Hooks
 
 Pre-commit hooks are scripts that run every time you make a commit. If any of the scripts fail, it stops the commit. You can see a listing of the checks in the ``.pre-commit-config.yaml`` file.
 
 ```console
 pre-commit install
 ```
+
+## Improving The Documentation
+Please, please help us here.
+
+## Styleguides
+### Coding Style
+
+All of the basic coding styles are configured into tools for fixing and checking them. [Pre-commit](https://pre-commit.com) is used to automate the process.
+
+### Commit Messages
+
+**Commit messages are used to generate the change log.**
+
+**New changes**
+
+Commit messages are categorized as "new" if the commit message starts with:
+
+- new
+- add
+
+For example: `Added this cool new feature` or `New document type added`.
+
+**Updates**
+
+Commit messages are categorized as "updates" if the commit message starts with:
+
+- update
+- change
+- rename
+- remove
+- delete
+- improve
+- refacto
+- chg
+- modif
+
+For example: `Modified the taxonomy schema` or `Improves performance by 419%`
+
+**Fixes**
+
+Commit messages are categorizes as "fixes" if the commit message starts with:
+
+- fix
+
+For example: `Fixes bug #123`
+
+**Other**
+
+All other commit messages are categorized as "other."
+
+**Ignoring commit messages**
+
+To have the change log generator ignore this commit, add to the summary line:
+
+- `@minor`
+- `!minor`
+- `@cosmetic`
+- `!cosmetic`
+- `@refactor`
+- `!refactor`
+- `@wip`
+- `!wip`
+
+## Join The Project Team
+
+If you would like to be a maintainer, reach out to coreyoordt@gmail.com.
+
+## Attribution
+This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!

README.md

@@ -27,14 +27,36 @@ commits and tags:
 * works without any source code manager, but happily reads tag information from and writes
   commits and tags to Git and Mercurial if available
 * just handles text files, so it's not specific to any programming language
-* supports Python 3 and PyPy3
+* supports Python 3.8+ and PyPy3. Python 3.7 should work but isn't actively tested.
 
+## Future Direction
 
-## Alternatives
+- Make it easier to get the current version
+- Switch having both the version part and files to change as arguments on the command line.
+- Make the version part argument _truly_ optional when `--new-version` is specified
+- Allow for multiple tags, including one that moves for having a `v2` that always points to the latest version of version 2.
+- https://github.com/c4urself/bump2version/issues/253 Have an always increment configuration
+- Better UI with [Rich](https://rich.readthedocs.io/en/stable/index.html)
 
-If bump-my-version does not fully suit your needs, you could take a look
-at other tools doing similar or related tasks:
-[ALTERNATIVES.md](https://github.com/c4urself/bump-my-version/blob/master/RELATED.md).
+**Potential bugs to verify**
+
+- https://github.com/c4urself/bump2version/issues/267 Ignore-missing error in files flag
+- https://github.com/c4urself/bump2version/issues/260 Incorrect behavior when new version == current version
+- https://github.com/c4urself/bump2version/issues/248 Potential bug/test case
+- https://github.com/c4urself/bump2version/issues/246 Release inconsistency
+- https://github.com/c4urself/bump2version/issues/233 How are relative configured file paths resolved?
+- https://github.com/c4urself/bump2version/issues/225 Properly resolve configuration file through parent directories when in a git or mercurial repo
+- https://github.com/c4urself/bump2version/issues/224 Verify tag doesn't exist
+
+**Documentation opportunities**
+
+- https://github.com/c4urself/bump2version/issues/252 
+- https://github.com/c4urself/bump2version/issues/247
+- https://github.com/c4urself/bump2version/issues/243
+- https://github.com/c4urself/bump2version/issues/240
+- https://github.com/c4urself/bump2version/issues/239
+- Add dates to releases in changelog
+- https://github.com/c4urself/bump2version/issues/200 Add CalVer examples
 
 ## Installation
 
@@ -127,17 +149,17 @@ Print help and exit
 
 ## Using bumpversion in a script
 
-If you need to use the version generated by bumpversion in a script you can make use of the `--list` option, combined with `grep` and `sed`.
+If you need to use the version generated by bumpversion in a script, you can make use of the `--list` option combined with `grep` and `sed`.
 
-Say for example that you are using git-flow to manage your project and want to automatically create a release. When you issue `git flow release start` you already need to know the new version, before applying the change.
+Say, for example, that you are using git-flow to manage your project and want to automatically create a release. When you issue `git flow release start` you need to know the new version before applying the change.
 
 The standard way to get it in a bash script is
 
     bump-my-version --dry-run --list <part> | grep <field name> | sed -r s,"^.*=",,
 
-where `part` is as usual the part of the version number you are updating. You need to specify `--dry-run` to avoid bumpversion acting.
+where `part` is the part of the version number you are updating. You need to specify `--dry-run` to avoid bumpversion acting.
 
-For example, if you are updating the minor number and looking for the new version number this becomes
+For example, if you are updating the minor number and looking for the new version number, this becomes
 
     bump-my-version --dry-run --list minor | grep new_version | sed -r s,"^.*=",,