input-range-scss
Version:
Sass component for customizing the input range using the native properties of each browser.
61 lines (50 loc) • 2.86 kB
Markdown
# Contributing to `input-range-scss`
Thank you for considering contributing to `input-range-scss`! We welcome contributions that help improve the project, whether it's fixing bugs, adding features, or enhancing documentation. Please follow the guidelines below to ensure a smooth contribution process.
## How to Contribute
### Reporting Issues
If you encounter a bug or have a feature request, please open an issue on the [GitHub repository](https://github.com/darlanrod/input-range-scss/issues). When reporting an issue, include:
- A clear and descriptive title.
- Steps to reproduce the issue.
- Expected and actual behavior.
- Screenshots or code snippets, if applicable.
- Browser and operating system details.
### Submitting Pull Requests
1. **Fork the Repository**: Create a fork of the repository on GitHub.
2. **Clone Your Fork**: Clone your fork to your local machine.
```bash
git clone https://github.com/your-username/input-range-scss.git
```
3. **Create a Branch**: Create a new branch for your changes.
```bash
git checkout -b feature/your-feature-name
```
4. **Make Changes**: Implement your changes, ensuring they align with the project's coding standards.
5. **Test Your Changes**: If applicable, test your changes to ensure they work as expected.
6. **Commit Your Changes**: Write clear and concise commit messages.
```bash
git commit -m "Add feature: your feature description"
```
7. **Push Your Changes**: Push your branch to your fork.
```bash
git push origin feature/your-feature-name
```
8. **Open a Pull Request**: Go to the original repository and open a pull request. Provide a detailed description of your changes and link any related issues.
### Coding Standards
- Follow the existing code style in the project.
- Use meaningful variable names and comments where necessary.
- Ensure your changes are compatible with Dart Sass 3.0.0 or later.
- Avoid introducing breaking changes unless absolutely necessary.
### Documentation
If your contribution affects the behavior or usage of the library, update the relevant documentation:
- Update the `README.md` file for usage instructions.
- Add or modify comments in the `_inputrange.scss` file for clarity.
### Testing
While the project currently lacks automated tests, please manually test your changes across supported browsers (Chrome, Firefox, Safari, Edge, and Internet Explorer) to ensure compatibility.
## General Tips for Contributing on GitHub
- Be respectful and constructive in discussions.
- Keep pull requests focused and concise.
- Respond to feedback promptly.
- Check for existing issues or pull requests before starting work to avoid duplication.
## License
By contributing to this project, you agree that your contributions will be licensed under the [MIT License](LICENSE).
Thank you for contributing to `input-range-scss`!