Skip to content

Latest commit

 

History

History
58 lines (39 loc) · 3.15 KB

CONTRIBUTING.md

File metadata and controls

58 lines (39 loc) · 3.15 KB

Contributing to PomoSuperFocus

Thank you for considering contributing to PomoSuperFocus! 💝😻🚀.

We welcome contributions from everyone, whether you're a seasoned developer or just getting started. This document outlines the process for contributing to the project.

Table of Contents

  1. Code of Conduct
  2. How to Contribute
  3. Reporting Bugs
  4. Suggesting Features
  5. Development Setup
  6. Pull Request Process
  7. Community

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

How to Contribute

  1. Join the Community: Join our Discord server to connect with other contributors and discuss ideas.
  2. Open an Issue: If you find a bug or have a feature request, please open an issue on GitHub.
  3. Work on an Issue: If you want to work on an issue, please comment on the issue and we will assign it to you. Once you have it assigned, you can start working on it following the Pull Request Process.

Reporting Bugs

  • Search for existing issues: Before reporting a bug, please check if it has already been reported.
  • Create a detailed report: Include steps to reproduce the bug, expected behavior, and screenshots if applicable.

Suggesting Features

  • Discuss first: Start a discussion on Discord or open an issue to propose your idea.
  • Be specific: Clearly describe the feature, its benefits, and any potential drawbacks.

Development Setup

  1. Fork the repository: Create your own copy of the repository.
  2. Clone the repository: git clone https://github.com/your-username/pomo-super-focus-webapp.git
  3. Install dependencies: Run npm install to install the necessary packages.
  4. Build the project: Run npm run build to build the project.
  5. Run the app: Use npm run start to start the development server.

Pull Request Process

  1. Create a branch: Use a descriptive name for your branch. We follow the convention of type/description (e.g., fix/bug-123 or feat/new-feature). You can see the existing branches here to get an idea.
  2. Commit your changes: Write clear and concise commit messages.
  3. Push to GitHub: Push your branch to your forked repository.
  4. Open a pull request: Submit your pull request to the master branch of the original repository.

Community

Thank you for your interest in contributing to PomoSuperFocus! Your contributions are greatly appreciated.