Skip to content

Latest commit

 

History

History
64 lines (43 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

64 lines (43 loc) · 3.09 KB

Contributing to Moola.js

Thank you for your interest in contributing to Moola.js! We appreciate your help and want to make sure that contributing is as easy and transparent as possible.

How Can I Contribute?

Reporting Bugs

If you find a bug, please create an issue on GitHub. Before submitting, please check if the bug has already been reported. When creating a bug report, include as much detail as possible:

  • Describe the bug: Provide a clear and concise description of what the bug is.
  • Steps to reproduce: List the steps to reproduce the bug.
  • Expected behavior: Explain what you expected to happen instead.
  • Screenshots: If applicable, add screenshots to help explain the issue.
  • Environment: Include details like the version of Moola.js, your operating system, and any other relevant information if necessary.

Suggesting Features

We welcome suggestions for new features or improvements to existing features! To submit a feature request:

  1. Search the issues to see if your idea has already been suggested.
  2. If it hasn't, open a new issue and select the "Feature Request" template.
  3. Provide a detailed explanation of the feature, including:
    • Use case: Describe the problem or need the feature will address.
    • Proposed solution: Explain how you think the feature should work.
    • Alternatives considered: If applicable, describe any alternative solutions you’ve considered.

Code Contributions

We love pull requests! If you’d like to contribute code to Moola.js, here’s how to get started:

  1. Fork the repository to your own GitHub account.
  2. Clone your fork to your local machine.
  3. Create a branch for your feature or bug fix.
  4. Make your changes. Write clear, concise, and well-documented code. If you’re adding a new feature or modifying an existing one, be sure to update or add tests to cover your changes.
  5. Run tests to ensure everything is working correctly.
  6. Commit your changes with a descriptive commit message.
  7. Push your branch to your fork.
  8. Submit a pull request to the main repository. In your pull request, describe what your changes do and why they’re necessary.

Code Style and Guidelines

Please adhere to the following guidelines when contributing code:

  • Coding Style: Follow the project's established coding style. Consistency is key.
  • Documentation: Update or add documentation for new features or changes. This includes updating the README, commenting your code, and adding JSDoc comments where appropriate.
  • Tests: Ensure that your code is covered by tests. Write unit tests for new features and bug fixes.

Reviewing Pull Requests

If you’re reviewing a pull request:

  • Be respectful and constructive in your feedback.
  • Ensure that the code follows the project's guidelines.
  • Test the changes locally if possible.
  • Review the documentation and tests included with the PR.

Conduct

We expect contributors to adhere to our Code of Conduct. Please treat everyone with respect and kindness.

License

By contributing to Moola.js, you agree that your contributions will be licensed under the MIT License.