Skip to content

Latest commit

 

History

History
128 lines (89 loc) · 5.37 KB

CONTRIBUTING.md

File metadata and controls

128 lines (89 loc) · 5.37 KB

Contributing to Cuchi-Pomodoro

Thank you for considering contributing to Cuchi-Pomodoro! Whether you're a beginner or an experienced developer, all contributions are welcome. This project is part of Hacktoberfest, so feel free to participate and make meaningful contributions.

Table of Contents

  1. Code of Conduct
  2. How to Contribute
  3. What to Contribute
  4. Best Practices for Contributing
  5. Submitting Pull Requests
  6. Getting Help

Code of Conduct

This project is guided by our Code of Conduct. We strive to foster a positive and inclusive environment for all contributors. By participating, you contribute to making Cuchi-Pomodoro a welcoming space for everyone!

How to Contribute

We value any kind of contribution. Here's how you can get started:

  • Report Bugs: Find an issue? Open a new issue with details on how to reproduce it.
  • Suggest Features: Have an idea to enhance the project? Open a new issue to discuss it.
  • Fix Bugs: Take a look at open issues and work on fixing bugs. Check the "good first issue" label if you're new to the project.
  • Improve Documentation: Documentation is key! Help us improve this file, the README, or add tutorials.
  • Write Unit Tests: Improve the test coverage by writing or enhancing unit tests.
  • Review Code: Provide feedback on open pull requests or issues, and suggest improvements.

Before contributing, please check existing issues or PRs to ensure you're not working on something already being handled.

What to Contribute

Here are a few areas where you can contribute to Cuchi-Pomodoro:

  1. Bug Fixes

    • Take a look at open issues and help fix existing bugs.
    • Report any new bugs and provide detailed steps to reproduce.

  2. New Features

    • Suggest new features that can improve the timer's functionality or user experience.
    • Work on implementing feature requests. Before starting, make sure the feature aligns with the project goals.

  3. UI/UX Enhancements

    • Improve the design and layout of the application.
    • Suggest or implement animations or themes to make the tool more visually appealing.

  4. Documentation Improvements

    • Enhance or clarify existing documentation, including installation steps, usage guides, or contributing guidelines.
    • Write tutorials or blog posts on how to use or extend the project.

  5. Unit Testing

    • Help us by improving the test coverage. Unit testing is powered by Vitest.
    • Write tests for uncovered features or functionality.

Best Practices for Contributing

To ensure your contribution is easy to review and integrate:

  1. Small, Focused Pull Requests: Avoid large PRs that mix many unrelated changes. Instead, make small, focused changes that address a single issue or feature.

  2. Write Clear Commit Messages: Write meaningful commit messages that explain the intent of your changes. For example:

    git commit -m "Fix bug in timer reset logic"

  3. Consistent Code Style: Follow the project's coding style. Make sure your code is properly formatted by running:

    npm run lint

  4. Document Your Changes: If you're adding a new feature, provide documentation (e.g., in the README) that explains how to use it.

  5. Be Descriptive in PRs: Clearly describe what your pull request does and why. If it fixes an issue, reference it using the issue number (e.g., "Fixes #12").

  6. Stay Up to Date: Before working on a new feature, pull the latest changes from the main branch to avoid conflicts.

Submitting Pull Requests

Follow these steps when you're ready to submit a pull request:

  1. Create a Branch
    Create a new branch for your work:

    git checkout -b your-feature-branch

  2. Make Your Changes
    Make sure your changes address the issue or feature you're working on. Add tests if applicable.

  3. Commit Your Changes
    Add and commit your changes with a descriptive message:

    git add .
git commit -m "Add [feature/bug] description"

  4. Push Your Branch
    Push your changes to your fork:

    git push origin your-feature-branch

  5. Create a Pull Request
    Open a pull request to the main repository. Provide a clear and detailed description of your changes. Reference any related issues (e.g., "Fixes #123").

  6. Wait for Review
    One of the maintainers will review your PR. Make sure to address any feedback or requested changes.

Getting Help

If you need assistance with setting up the project or have any questions about contributing, here are some ways to get help:

  • Open an Issue: If you encounter a problem or have a question, feel free to open an issue in the repository. Provide as much detail as possible so we can assist you effectively.
  • Check the Documentation: Review the project's documentation, including the README and this contributing guide. You might find answers to common questions.
  • Reach Out to Maintainers: You can reach out to the project maintainers directly through GitHub Discussions or by commenting on an issue. We're here to help!

We appreciate your engagement and can't wait to see your awesome contributions—let's make Cuchi-Pomodoro even better together!