📝 Switched documentation to Markdown

Author: drearondov

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented here.
+This changelog follows the conventions of [keepachangelog.com](http://keepachangelog.com/).
+
+## [Unreleased](https://github.com/drearondov/pygments-rose-pine/compare/v1.0.0...HEAD)
+
+## [v1.0.0 (2023-12-07)](https://github.com/drearondow/pygments-rose-pine/compare/3f11e57...v1.0.0)
+
+Initial release.
+
+- Rose Pine main theme
+- Rose Pine Moon theme
+- Rose Pine Dawn theme

CHANGELOG.rst

@@ -0,0 +1,78 @@
+# 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 via email. 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://www.contributor-covenant.org), 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).
+
+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>.

CODE_OF_CONDUCT.md

@@ -0,0 +1,100 @@
+# Contributing Guidelines
+
+Please follow these guidelines for contributing to this project.
+
+## Repository Management
+
+- Fork this project into your own repository.
+- Follow the [version control](#version control) guidelines.
+- No changes should reach the `main` branch except by way of a [pull
+    request](https://help.github.com/articles/using-pull-requests/).
+
+### Submitting Issues
+
+[Create an issue](https://help.github.com/articles/creating-an-issue) to report bugs or request enhancements. Better yet, you're encouraged to fix the problem yourself and submit a [pull request](https://help.github.com/articles/using-pull-requests/).
+
+#### Bug Reports
+
+When reporting a bug, please provide the steps to reproduce the problem and any details that could be important such as whether this is the first time this has happened or whether others are experiencing it.
+
+#### Pull Requests
+
+Pull requests must remain focused on fixing or addressing one thing (see [topic branch](https://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows#Topic-Branches) model). Make sure your pull request contains a clear title and description. Test coverage should not drop as a result. If you add code, you add tests.
+
+Be sure to follow the guidelines on [writing code](#writing-code) if you want your work considered for inclusion.
+
+### Handling Pull Requests
+
+- Pull requests **must** include:
+  - Title describing the change
+  - Description explaining the change in detail
+  - Tests
+- A maintainer will respond to Pull Requests with one of:
+  - `Ship It`, `LGTM`, 🚢, or some other affirmation
+  - What must be changed
+  - Won't accept and why
+
+> Submitting a [draft pull
+request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests)
+is a good way to get feedback from maintainers if you are unsure about
+your changes. - A pull request that has been approved may not be merged
+immediately. - You may be asked to rebase or squash your commits to keep
+an orderly version control history.
+
+### Using Version Control
+
+- [Fork](https://help.github.com/articles/fork-a-repo/) the [central repository](https://github.com/drearondov/pygments-rose-pines/) and work from a clone of your own fork.
+- Follow the [topic branch](https://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows#Topic-Branches) model and submit pull requests from branches named according to their purpose.
+- Review the [GitHub Flow](https://guides.github.com/introduction/flow/) documentation and, in general, try to stick to the principles outlined there.
+
+## Writing Code
+
+Writing code is a creative process and there will always be exceptions to the rules, but it\'s good to maintain certain standards. In general, please follow these code conventions.
+
+### Coding Style
+
+- Code in this project **must** be formatted with [black](https://black.readthedocs.io/en/stable/).
+- Code in this project **must** be linted with [flake8](https://flake8.pycqa.org/en/latest/).
+- Try to follow PEP8 guidelines.
+- Try to respect the style of existing code.
+
+Coding style checks are bundled into the static analysis automation in this repository\'s [tox](https://tox.readthedocs.io/en/latest/) configuration. To validate your coding style run
+
+``` sh
+tox -e static
+```
+
+### Test Environment
+
+- Code **must** be tested. Write or update related unit tests to avoid
+    repeated manual testing.
+- Tests for this project are written using the [pytest](https://docs.pytest.org/en/latest/) framework and executed via [tox](https://tox.readthedocs.io/en/latest/).
+- While it isn\'t always achievable this project strives to maintain 💯% test coverage.
+- In addition to unit testing code in this project is
+  - statically type checked using [mypy](http://www.mypy-lang.org/)
+  - formatted with [black](https://black.readthedocs.io/en/stable/)
+  - linted using [flake8](https://flake8.pycqa.org/en/latest/)
+  - and security checked with [bandit](https://bandit.readthedocs.io/en/latest/)
+
+Here are some example invocations for running unit tests/static
+analysis.
+
+``` sh
+tox                        # Build and test the project
+tox -e py39                # in a specific environment
+tox -e py39 -- --pdb       # with extra options,
+                           # or
+tox -e py39 --devenv venv  # create a development environment
+venv/bin/python -V         # and call scripts/binaries in it.
+```
+
+### Documentation
+
+- Public interfaces **must** be thoroughly documented. At a minimum this includes inputs, return types, exceptions raised, and surprising behavior like state changes.
+- Documentation for this project is written in [Markdown](https://www.markdownguide.org) and generated with [Sphinx](http://www.sphinx-doc.org/en/master/index.html).
+
+To generate documentation run
+
+``` sh
+tox -e docs
+```