diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index d3e1de3..0000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,116 +0,0 @@ -# Contributor Covenant Code of Conduct - -- [Contributor Covenant Code of Conduct](#contributor-covenant-code-of-conduct) - - [Our Pledge](#our-pledge) - - [Our Standards](#our-standards) - - [Enforcement Responsibilities](#enforcement-responsibilities) - - [Scope](#scope) - - [Enforcement](#enforcement) - - [Enforcement Guidelines](#enforcement-guidelines) - - [Correction](#correction) - - [Warning](#warning) - - [Temporary Ban](#temporary-ban) - - [Permanent Ban](#permanent-ban) - - [Attribution](#attribution) - -## 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 behaviour 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 behaviour 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 behaviour 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 with 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 behaviour may be reported to the community -leaders responsible for enforcement. 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: - -### Correction - -**Community Impact**: Use of inappropriate language or other behaviour 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 behaviour was inappropriate. A public apology -may be requested. - -### Warning - -**Community Impact**: A violation through a single incident or series of actions. - -**Consequence**: A warning with consequences for continued behaviour. No interaction with the people -involved, including unsolicited interaction with those enforcing the Code of Conduct, for a -specified period. 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. - -### Temporary Ban - -**Community Impact**: A serious violation of community standards, including sustained inappropriate -behaviour. - -**Consequence**: A temporary ban from any sort of interaction or public communication with the -community for a specified period. 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. - -### Permanent Ban - -**Community Impact**: Demonstrating a pattern of violation of community standards, including -sustained inappropriate behaviour, 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. - -Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 0a4147b..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,138 +0,0 @@ -# Contributing - -- [Contributing](#contributing) - - [Reporting Bugs](#reporting-bugs) - - [How Do I Submit a Bug Report?](#how-do-i-submit-a-bug-report) - - [Suggesting Enhancements](#suggesting-enhancements) - - [How Do I Submit A Suggested Enhancement?](#how-do-i-submit-a-suggested-enhancement) - - [Code Contributions](#code-contributions) - - [Local Development](#local-development) - - [Commits](#commits) - - [Pull Requests](#pull-requests) - -First of all, thanks for taking the time to contribute! - -The following is a set of guidelines for contributing to `catppuccin-startpage`. These are mostly guidelines, -not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. - -## Reporting Bugs - -This section guides you through submitting a bug report for `catppuccin-startpage`. Following these guidelines -helps maintainers and the community understand your report, reproduce the behaviour, and find related reports. - -Before creating bug reports, please check that your issue does not already exist in the issue tracker. -When you are creating a bug report, please include as many details as possible. Fill out the required -template the information it asks helps the maintainers resolve the issue faster. - -> [!NOTE] -> If you find a **Closed** issue that seems like it is the same thing that you're experiencing, -> open a new issue and include a link to the original issue in the body of your new one. - -### How Do I Submit a Bug Report? - -Bugs concerning `catppuccin-startpage` should be submitted to the main issue tracker, using the correct issue template. - -Explain the problem and make it easy for others to search for and understand: - -- Use a clear and descriptive title for the issue to identify the problem -- Describe the exact steps which reproduce the problem in as many details as possible -- Describe the behaviour you observed after following the steps and point out how this is a bug -- Explain which behaviour you expected to see instead and why - -Provide detailed steps for reproduction of your issue: - -- Provide specific examples to demonstrate the steps to reproduce the issue. This could be an example repository, a sequence of steps run in a container -- Are you unable to reliably reproduce the issue? If so, provide details about how often the problem happens and under which conditions it normally happens - -Provide more context by answering these questions: - -- Did the problem start happening recently (e.g. after updating to a new version of `catppuccin-startpage`) or was this always a problem? -- If the problem started happening recently, can you reproduce the problem in an older version of `catppuccin-startpage`? What’s the most recent version in which the problem does not happen? -- Is there anything exotic or unusual about your environment? This could include the use of special container images, newer CPU architectures like Apple Silicon - -Include details about your configuration and environment: - -- What’s the name and version of the OS you’re using? - -To give others the best chance to understand and reproduce your issue, please be sure to put extra effort into your reproduction steps. You can both rule out local configuration issues on your end, and ensure others can cleanly reproduce your issue if attempt all reproductions in a pristine container (or VM), and provide the steps you performed inside that container/VM in your issue report. - -## Suggesting Enhancements - -This section guides you through submitting an enhancement suggestion for `catppuccin-startpage`, -including completely new features as well as improvements to existing functionality. -Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions. - -Before creating enhancement suggestions, please check this list as you might find out that you don't -need to create one. When you are creating an enhancement suggestion, please include as many details -as possible. Fill in the template, including the steps that you imagine you would -take if the feature you're requesting existed. - -### How Do I Submit A Suggested Enhancement? - -Suggested enhancements concerning `catppuccin-startpage` should be submitted to the main issue tracker, using the correct issue template. - -- Use a clear and descriptive title for the issue to identify the suggestion -- Provide a detailed description of the proposed enhancement, with specific steps or examples when possible -- Describe the current behaviour and explain which behaviour you would like to see instead, and why - -## Code Contributions - -### Local Development - -You should first fork the `catppuccin-startpage` repository and then clone it locally so that you can make pull requests against the project. -If you are new to `git` and pull request based development, GitHub provides a [guide](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) you will find helpful. - -The [`pre-commit`](https://pre-commit.com) tool is used to install and run liniting tools, and requires one-time setup: - -```shell -pre-commit install -``` - -`pre-commit` will now run and check your code every time you make a commit. -By default, it will only run on changed files, but you can run it on all files manually (this may be useful if you altered the `pre-commit` config): - -```shell -pre-commit run --all-files -``` - -### Commits - -We follow the [conventional commit message syntax](https://www.conventionalcommits.org/en/v1.0.0) for our commits. For instance: -`feat: allow provided config object to extend other configs`. - -Every feature branch that is squashed onto the main branch must follow these rules. The benefits are: - -- A standard way of writing commit messages for every contributor -- A way to quickly see and understand what the commit does and what it affects -- Automatic changelog creation based on those keywords - -The keywords that support (heavily inspired by [`config-conventional`](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional)): - -- `ci` -- `chore` -- `docs` -- `feat` -- `fix` -- `perf` -- `refactor` -- `revert` -- `style` -- `test` - -Moreover, every commit message needs to be written in lowercase. - -> [!NOTE] -> All the commits in a pull request are squashed when merged into the `main` branch. That means only the commit message of the squashed branch needs to follow this commit message convention. -> That also means that you don't need to follow this convention for commits within a branch, which will usually contain a lot of commits with a `wip` title - -### Pull Requests - -- Fill out the pull request body completely and describe your changes as accurately as possible. The pull request body should be kept up to date as it will usually form the base for the final merge commit and the changelog entry -- Be sure that your pull request contains tests that cover the changed or added code. Tests are generally required for code to be considered mergeable, and code without passing tests will not be merged -- Ensure your pull request passes all checks. Remember that you can run these tools locally instead of relying on remote CI -- If your changes warrant a documentation change, the pull request must also update the documentation. Make sure to review the documentation preview generated by CI for any rendering issues - -> [!NOTE] -> Make sure your branch is rebased against the latest `main` branch. A maintainer might ask you to ensure the branch is up-to-date prior to merging your pull request (especially if there have been CI changes on the `main` branch), and will also ask you to fix any conflicts - -All pull requests, unless otherwise instructed, need to be first accepted into the `main` branch. Maintainers will generally decide if any backports to other branches are required, and carry them out as needed. diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 47eef01..0000000 --- a/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2024 Volodymyr Pivoshenko - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 3d42a9e..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,24 +0,0 @@ -# Security Policy - -- [Security Policy](#security-policy) - - [Supported Versions](#supported-versions) - - [Reporting a Vulnerability](#reporting-a-vulnerability) - -## Supported Versions - -Use this section to tell people about which versions of your project are currently being supported -with security updates. - -| Version | Supported | -| ------- | ------------------ | -| 5.1.x | :white_check_mark: | -| 5.0.x | :x: | -| 4.0.x | :white_check_mark: | -| \< 4.0 | :x: | - -## Reporting a Vulnerability - -Use this section to tell people how to report a vulnerability. - -Tell them where to go, how often they can expect to get an update on a reported vulnerability, what -to expect if the vulnerability is accepted or declined, etc.