Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (21 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) · 1.25 KB

Contributing

Thank you for taking the time to contribute to this project. I greatly appreciate your support and enthusiasm! I know there's a long road ahead, and I'm excited to walk it with you.

Before you get started, please review the Code of Conduct. By following it, we can all help maintain a welcoming and respectful community for everyone.

Commit Message Guidelines

I use Conventional Commits to keep the commit history organized and meaningful:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Code formatting, white-space, etc.
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • test: Adding or correcting tests
  • chore: Changes to the build process or auxiliary tools

Branching

  • Always create a new branch (off main) for your changes.
  • Use descriptive branch names to clarify the purpose or scope of the work.

Pull Requests

  • Keep PRs small and focused.
  • Include any relevant tests for new features or bug fixes.
  • Reference related issues or context for clarity.

Thank you again for contributing. Your help is invaluable, and I look forward to building something amazing together!