Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (46 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

69 lines (46 loc) · 2.82 KB
Raw

Contributing to jqplay

Thank you for considering contributing to jqplay! We welcome contributions from everyone. By participating in this project, you agree to abide by our code of conduct.

How to Contribute

Reporting Bugs

If you find a bug, please report it by opening an issue on our GitHub repository. Include as much detail as possible to help us understand and reproduce the issue.

Suggesting Features

We welcome feature suggestions! If you have an idea for a new feature, please open an issue on our GitHub repository and describe your idea in detail.

Submitting Pull Requests

  1. Fork the repository: Click the "Fork" button at the top right corner of the repository page to create a copy of the repository in your GitHub account.

  2. Clone your fork: Clone your forked repository to your local machine using the following command:

    git clone https://github.com/<your-username>/jqplay.git
cd jqplay

  3. Create a new branch: Create a new branch for your changes using the following command:

    git checkout -b my-feature-branch

  4. Make your changes: Make your changes to the codebase. Ensure that your code follows the project's coding style and conventions.

  5. Test your changes: Run the tests to ensure that your changes do not break any existing functionality. You can run the tests using the following command:

    npm test

  6. Commit your changes: Commit your changes with a descriptive commit message using the following command:

    git commit -m "Add feature XYZ"

  7. Push your changes: Push your changes to your forked repository using the following command:

    git push origin my-feature-branch

  8. Create a pull request: Go to the original repository on GitHub and click the "New pull request" button. Select your branch from the "compare" dropdown and click "Create pull request". Provide a detailed description of your changes in the pull request.

Code Style

Please ensure that your code follows the project's coding style and conventions. We use ESLint to enforce code quality and consistency. You can run the linter using the following command:

npm run lint

Testing

We use Jest for testing. Please ensure that your changes are covered by tests. You can run the tests using the following command:

npm test

Code of Conduct

By participating in this project, you agree to abide by our code of conduct. Please read it to understand the expectations for behavior when interacting with the community.

Thank You!

Thank you for your contributions! Your support and involvement help make jqplay better for everyone.