Skip to content

Latest commit

 

History

History
71 lines (37 loc) · 3.19 KB

CONTRIBUTING.md

File metadata and controls

71 lines (37 loc) · 3.19 KB
Raw

Contributing

Thank you for your valuable contribution and dedication to improving this project! We greatly appreciate your involvement. To ensure a smooth and cohesive collaboration, we have provided some guidelines to help you get started. Kindly take a moment to review them before submitting your contributions. Your efforts will undoubtedly make this project even better, and we look forward to working together on its success!.

Code of Conduct

This project is governed by the Contributor Covenant Code of Conduct. By participating, you are expected to adhere to it.

Open Development

All work happens directly on GitHub. Both core team members and external contributors send pull requests which go through the same code review process.

Semantic Versioning

This project follows semantic versioning. We release patch versions for bug fixes or other changes that do not change the behavior of the API, minor versions for new features that are backward-compatible, and major versions for any breaking changes.

Every significant change is documented in the changelog file.

Reporting Issues

Welcome to svelte-marquee ! We value your feedback and contributions to make this project better. If you encounter any bugs or have feature requests, please use Github issues issues to submit them.

Before reporting an issue, we ask you to:

  1. Search for Similar Issues : Ensure you have searched through our existing issues to see if the problem or feature request has already been addressed or is under discussion.

  2. Reproduce the Bug : If reporting a bug, please provide the minimum code required to reproduce the issue. This will help us understand and resolve the problem more efficiently.

  3. Describe Feature Requests : For feature requests, please describe the desired functionality and any additional context that might be helpful.

Your participation and attention to these guidelines will help us maintain a more organized and effective development process.

Commit Guidelines

Commit messages are required to follow the conventional-changelog standard:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

👉 Commit example

Commit types

The following is a list of commit types:

Commit Types:

  • feat: Adding a new snippet or significant functionality to the svelte-marquee package.

  • fix: Addressing bugs or issues in existing svelte-marquee package.

  • docs: Commits related to documentation changes for svelte-marquee package.

  • style: Commits related to code formatting, styling, or theming of svelte-marquee package.

  • refactor: Code changes that enhance the library's structure without introducing new features or fixing bugs.

  • perf: Commits aimed at improving performance for svelte-marquee package.

  • test: Commits related to testing svelte-marquee package.

  • chore: Other commits not affecting source or test files directly.

License

By contributing your code to the repository, you agree to license your contribution under the MIT license.