vue-tag-maker
Version:
A customizable tag input component for Vue 3
72 lines (50 loc) • 3.11 kB
Markdown
# Contributing to react-tag-maker
Thank you for your interest in contributing to the `react-tag-maker` project! We appreciate your help in improving this library. To ensure that your contributions are consistent with our project's standards and practices, please follow the guidelines outlined below.
## How to Contribute
1. **Fork the Repository**
- Click the "Fork" button at the top right corner of the [react-tag-maker repository](https://github.com/gloomystore/react-tag-maker) page to create a personal copy of the repository.
2. **Clone Your Fork**
- Clone your forked repository to your local machine:
```bash
git clone https://github.com/gloomy-store/react-tag-maker.git
```
3. **Create a New Branch**
- Create a new branch for your changes:
```bash
git checkout -b my-feature-branch
```
4. **Make Your Changes**
- Implement your changes or new features. Ensure that your code follows the existing coding style and conventions of the project.
5. **Write Tests**
- If your changes include new features or bug fixes, write corresponding tests to ensure that your modifications work as expected and do not introduce new issues.
6. **Run Tests**
- Before submitting your pull request, make sure all tests pass by running:
```bash
npm test
```
7. **Commit Your Changes**
- Commit your changes with a clear and concise commit message:
```bash
git add .
git commit -m "Add a brief description of the changes"
```
8. **Push to Your Fork**
- Push your changes to your forked repository:
```bash
git push origin my-feature-branch
```
9. **Open a Pull Request**
- Navigate to the [pull requests](https://github.com/gloomystore/react-tag-maker/pulls) section of the original repository.
- Click the "New Pull Request" button.
- Select your branch and provide a detailed description of the changes in your pull request.
## Coding Standards
- **Code Style**: Follow the existing code style used in the project. Use ESLint and Prettier configurations included in the project to ensure consistency.
- **Documentation**: Update the documentation (e.g., README.md) if your changes affect the usage or functionality of the library.
- **Commit Messages**: Use clear and descriptive commit messages. Refer to issues using the format `Fixes #issue-number` if applicable.
## Reporting Issues
If you encounter any bugs or issues, please report them by creating a new issue on the [Issues page](https://github.com/gloomystore/react-tag-maker/issues) of the repository. Provide a clear description of the problem and steps to reproduce it.
## Code of Conduct
By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). We expect all contributors to be respectful and professional in their interactions.
## Contact
For any questions or further assistance, please reach out to us via the [GitHub Discussions](https://github.com/gloomystore/react-tag-maker/discussions) or open an issue on the repository.
Thank you for contributing to `react-tag-maker`!