Skip to content

Latest commit

 

History

History
69 lines (46 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

69 lines (46 loc) · 2.21 KB

Contribution Guidelines

Thank you for considering contributing to BeUnblurred! We welcome all contributions that improve the project. Please take a moment to review these guidelines before submitting your contribution.

How to Contribute

  1. Fork the repository
    Begin by forking the repository to your own GitHub account. This allows you to make changes without affecting the main repository.

  2. Clone the repository
    After forking, clone the repository to your local machine:

    git clone https://github.com/YOUR-USERNAME/beunblurred.git
cd beunblurred

  3. Create a branch
    Always create a new branch for your contribution:

    git checkout -b your-branch-name

  4. Make your changes
    Ensure that your changes are well tested. If you're adding new functionality, include tests to verify it works.

  5. Run the tests
    Before submitting, make sure all tests pass:

    npm test

  6. Commit your changes
    Commit your changes with a meaningful message:

    git add .
git commit -m "Description of your changes"

  7. Push your branch
    Push the branch to your forked repository:

    git push origin your-branch-name

  8. Submit a pull request (PR)
    Once pushed, go to the original repository and submit a PR. Ensure that you provide a clear description of the changes and the issue they resolve (if applicable).

Code Style

  • Follow the existing code style. The repository uses ESLint for linting. Make sure your code is linted before submission.
  • Ensure variable and function names are descriptive.
  • Keep the code DRY (Don’t Repeat Yourself) and clean.

Reporting Issues

If you encounter any bugs or have ideas for improvement, feel free to open an issue and provide as much information as possible (steps to reproduce, expected behavior, etc.).

Code of Conduct

The repository aims to foster an open and welcoming environment. Please be respectful to others and follow the Contributor Covenant Code of Conduct.

Thank you for contributing to BeUnblurred!