Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (29 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

45 lines (29 loc) · 2.42 KB
Raw

Contributing to Remind Karo

First off, thank you for considering contributing to Remind Karo! It's people like you that make open source software such a great community to learn, inspire, and create.

Where do I go from here?

If you've noticed a bug or have a feature request, please make sure to check if there is an existing issue. If not, open a new issue describing your problem or suggestion.

Setting up your environment

  1. Fork the repository: Click the "Fork" button at the top right of this page to copy this repository to your GitHub account.
  2. Clone the repository: git clone https://github.com/YOUR-USERNAME/RemindKaro.git
  3. Navigate to the project directory: cd RemindKaro
  4. Install dependencies: Run npm install to install all required dependencies.
  5. Set up environment variables: Copy .env.example to .env.local (if applicable) and fill in the required keys.

Development Workflow

  1. Create a branch: git checkout -b feature/your-feature-name or bugfix/issue-number
  2. Make your changes: Write clean, readable code. Make sure your changes don't break existing functionality.
  3. Format and lint: Run npm run format and npm run lint before committing your code.
  4. Test your code: If you've added new features, ensure they work as intended. Run npm run build to verify the build process succeeds.
  5. Commit your changes: Write clear, descriptive commit messages.

Submitting a Pull Request

  1. Push your branch: git push origin feature/your-feature-name
  2. Open a Pull Request: Go to the original Remind Karo repository and click "Compare & pull request".
  3. Describe your changes: Fill out the PR template carefully, linking any related issues.
  4. Code Review: The maintainers will review your PR and may suggest changes. Once approved, your PR will be merged!

Contribution Leaderboard

Want to see how your contributions stack up? Check out the live contributor scoreboard for RemindKaro:

View Contribution Leaderboard

This leaderboard is powered by GitHub's native contribution metrics and updates automatically with every merged commit. Climb the ranks by fixing bugs, adding features, or improving documentation!

Contact

If you have any questions, feel free to reach out to the project owner: