Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 1.53 KB

Contributing to Moka-DOM

We welcome contributions to Moka-DOM! Here are some guidelines to help you get started.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally.
  3. Set up the development environment (see README.md for requirements).
  4. Create a new branch for your feature or bug fix.

Making Changes

  1. Make your changes in your branch.
  2. Add or update tests as necessary.
  3. Run the test suite to ensure all tests pass.
  4. Update the documentation if you've made interface changes.
  5. Update the CHANGELOG.md file with a brief description of your changes.

Submitting Changes

  1. Push your changes to your fork on GitHub.
  2. Submit a pull request to the main repository.
  3. Describe your changes in the pull request description.
  4. Link to any relevant issues.

Code Style

  • Follow the existing code style in the project.
  • Everything is up for debate but the aim of this repo is simple and generic code
  • Comment your code where necessary, especially for complex logic.

Reporting Bugs

  • Use the GitHub issue tracker to report bugs.
  • Describe the bug in detail, including steps to reproduce.
  • Include the version of Moka-DOM and GHC you're using.

Requesting Features

  • Use the GitHub issue tracker to suggest new features.
  • Explain the feature in detail and why it would be useful.

Questions?

If you have any questions about contributing, feel free to open an issue asking for clarification.

Or you can just message me directly at shane@peregrinum.dev

Thank you for contributing to Moka-DOM!