Skip to content

Latest commit

 

History

History
27 lines (15 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

27 lines (15 loc) · 1.78 KB

Contributing to Vertical Timeline Component for React

Do you want to help me maintain this project? Here's how you can help. Please take a moment to review this document to make the contribution process easy and effective for everyone 💖

Feature requests

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince me of the merits of this feature. Please provide as much detail and context as possible.

Pull requests

Good pull requests, such as patches, improvements, and new features, are a fantastic help. They should remain focused in scope and avoid containing unrelated commits. If your contribution involves a significant amount of work or substantial changes to any part of the project, please open an issue to discuss it first. This will help ensure that your precious work is not in vain. Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language). I'm happy to discuss your ideas.

Code guidelines

  • Code style: I use Prettier to format my code. Please use it too.
  • Tests: I use Jest with Testing Library to test my code. Please write tests for your code.

Run npm run test before committing to ensure your changes follow our coding standards.

Commit guidelines

  • Commit message format: I use Conventional Commits to format my commit messages. Please use it too.

License

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