diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..ca56d6e --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,3 @@ +# Code of Conduct + +We can make something valuable together. diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..99287a6 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,11 @@ +# Contributing + +Hey, let's make this project better together! 🎉 + +Fork this repository, make your changes, and submit a pull request. We'll review your changes and reach out if we have any questions. + +[Conventional Commits](https://www.conventionalcommits.org/) are used to manage the project's versioning and changelog. + +Release workflow is based on [semantic-release workflow](https://semantic-release.gitbook.io/semantic-release/usage/workflow-configuration). + +## Development diff --git a/.github/DISCUSSION_TEMPLATE/ideas.yml b/.github/DISCUSSION_TEMPLATE/ideas.yml new file mode 100644 index 0000000..9061c68 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/ideas.yml @@ -0,0 +1,49 @@ +title: "Ideas" +body: + - type: markdown + attributes: + value: | + Share ideas for new features + - type: markdown + id: showcase + attributes: + label: Showcase + description: "Practical example or scenario demonstrating the impact of the idea" + render: auto + validations: + required: true + - type: markdown + attributes: + value: | + ## Markdown header + And some more markdown + - type: checkboxes + id: breaking-change + attributes: + label: Breaking changes + description: Indicate if your idea introduces changes that require altering any current behavior + validations: + required: true + - type: dropdown + id: download + attributes: + label: Which area of this project could be most improved? + options: + - Documentation + - Pull request review time + - Bug fix time + - Release cadence + validations: + required: true + - type: checkboxes + attributes: + label: Check that box! + options: + - label: This one! + required: true + - label: I won't stop you if you check this one, too + - type: markdown + attributes: + value: | + ### The thrilling conclusion + _to our template_ diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..b7647dc --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,2 @@ +github: vendor +custom: diff --git a/.github/GOVERNANCE.md b/.github/GOVERNANCE.md new file mode 100644 index 0000000..9f5377e --- /dev/null +++ b/.github/GOVERNANCE.md @@ -0,0 +1,25 @@ +# Governance + +This document outlines the governance model for the project. + +## Decision Making Process + +All major decisions regarding the project will be made through a consensus-based approach. Contributors are encouraged to participate in discussions and provide their input. The final decision will be made by the project maintainers. + +## Roles and Responsibilities + +### Project Maintainers + +The project maintainers are responsible for overseeing the development and maintenance of the project. They have the authority to make final decisions and ensure that the project is moving forward. + +### Contributors + +Contributors are individuals who actively contribute to the project by submitting pull requests, reporting issues, or participating in discussions. They play a crucial role in the success of the project. + +## Code of Conduct + +We expect all contributors to adhere to our [Code of Conduct](./CODE_OF_CONDUCT.md) to maintain a respectful and inclusive environment for everyone involved in the project. + +## Contributing + +If you would like to contribute to the project, please refer to our [Contributing Guidelines](./CONTRIBUTING.md) for more information. diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000..638f4cb --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,37 @@ + + +## Pull Request Template + +### Description + +Please provide a brief description of the changes made in this pull request. + +### Related Issues + +List any related issues or tickets that this pull request addresses. + +### Checklist + +- [ ] I have tested the changes locally and they are working as expected. +- [ ] I have added appropriate documentation or comments where necessary. +- [ ] I have followed the coding style and conventions of the project. +- [ ] I have updated any necessary tests to reflect the changes made. +- [ ] I have assigned the pull request to the appropriate reviewer(s). + +### Screenshots (if applicable) + +If the changes include any visual modifications, please provide screenshots or GIFs to showcase the changes. + +### Additional Notes + +Add any additional notes or context about the changes made in this pull request. diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md new file mode 100644 index 0000000..c8b1263 --- /dev/null +++ b/.github/SUPPORT.md @@ -0,0 +1,23 @@ +# Support + +Welcome to the support page for our project! If you have any questions, issues, or need assistance, please follow the guidelines below. + +## Getting Help + +If you need help or have questions about using our project, you have a few options: + +1. **Documentation**: Check out our [official documentation](https://example.com/docs) for detailed information on how to use our project. + +2. **Issue Tracker**: If you encounter a bug or have a feature request, please [open an issue](https://example.com/issues) on our GitHub repository. Be sure to provide as much detail as possible to help us understand and reproduce the problem. + +3. **Community**: Join our [community forum](https://example.com/forum) to connect with other users and get help from the community. Feel free to ask questions, share your experiences, and contribute to discussions. + +## Contributing + +We welcome contributions from the community! If you would like to contribute to our project, please follow our [contribution guidelines](https://example.com/contributing) to get started. + +## Contact + +If you need to contact us directly, you can reach out to our support team at . + +We appreciate your interest in our project and look forward to assisting you! diff --git a/package.json b/package.json index 691efda..ee1c5a8 100644 --- a/package.json +++ b/package.json @@ -24,7 +24,6 @@ "build": "tsc && vite build", "lint": "eslint . --fix", "test": "vitest --run", - "test:watch": "vitest", "test:coverage": "vitest --coverage --run", "prepare": "husky" },