Skip to content

Latest commit

 

History

History
57 lines (37 loc) · 3.08 KB

CONTRIBUTING.md

File metadata and controls

57 lines (37 loc) · 3.08 KB

Contributing to Rizzy

Thank you for considering contributing to Rizzy! Rizzy makes it painless to integrate Razor components with MVC for UI development along with HTMX. This unique combination allows developers to build dynamic, interactive user interfaces while ensuring a seamless user experience.

Getting Started

Before you dive in, we encourage you to participate in our Discussions page. It's a great place to ask questions, share ideas, or get to know the Rizzy community.

Reporting Issues

Found a bug or have a feature suggestion? Please check our Issues page to see if it has already been reported. If not, feel free to open a new issue. When creating an issue, provide as much relevant information as possible to help us understand the problem or feature request.

Suggested Workflow for Contributions

We recommend the following workflow for contributions to Rizzy:

  1. Issue Creation:

    • For significant changes, create an issue first. Describe the proposed change and get feedback from the community.
    • For minor changes or bug fixes, you can skip this step.
    • Use existing issues when possible. If you plan to tackle an issue, comment that you're working on it and request assignment.

  2. Fork and Branch:

    • Fork the Rizzy repository and create a branch from the main for your work (git checkout -b mybranch).

  3. Developing:

    • Implement your changes, adhering to the Rizzy coding standards and guidelines.
    • Write or update tests for your changes.
    • Ensure your code follows the Conventional Commits style for commit messages.

  4. Testing:

    • Build the project and run tests to ensure everything works as expected, including new and existing tests.

  5. Submitting a Pull Request (PR):

    • Push your changes to your fork and submit a PR to the dev branch of Rizzy.
    • In the PR description, reference the issue it addresses.
    • Await feedback or approval from the project maintainers.

  6. After Your PR is Merged:

    • Once approved and merged, you may delete your branch.
    • Congratulations! You've contributed to Rizzy. 🎉

Contribution Guidelines

  • Code Style: Follow existing coding styles in the project. This includes using meaningful variable names, commenting your code when necessary, and adhering to the project's architectural patterns.
  • Testing: Add tests for every new feature or bug fix. Ensure that all tests pass before submitting a PR.
  • Documentation: Update documentation to reflect any changes in functionality or usage patterns.
  • Respect: Treat all contributors with respect. We strive to make this project welcoming to all.

Code of Conduct

See CODE-OF-CONDUCT.md

Need Help?

If you're stuck or have questions, don't hesitate to reach out on our Discussions page. Our community is here to help!

Thank you for contributing to Rizzy, and we look forward to your contributions!