Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (37 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

50 lines (37 loc) · 2.13 KB

Contributing to TinyStatus

Thank you for considering contributing to TinyStatus! We welcome contributions from everyone. Here are some guidelines to help you get started.

Hacktoberfest Participation

We are excited to participate in Hacktoberfest! To join the Hacktoberfest vibes and contribute to TinyStatus, here’s what you need to know to participate and complete Hacktoberfest:

  1. Register anytime between September 23 and October 31 Pull/merge requests can be made in any GitHub or GitLab hosted project that’s participating in Hacktoberfest (look for the “hacktoberfest” topic)
  2. Aim to submit four high-quality pull/merge requests between October 1 and October 31, with project maintainers accepting your pull/merge requests for them to count toward your total
  3. You’ll unlock a digital badge when you register for Hacktoberfest, and level it up with each of your four pull/merge requests accepted during Hacktoberfest
  4. Join the Hacktoberfest Discord server to meet other participants and share your Hacktoberfest love with a blog or post on socials.

Happy coding and thank you for contributing to TinyStatus during Hacktoberfest!

How to Contribute

  1. Fork the repository: Click the "Fork" button at the top right of the repository page.
  2. Clone your fork: 
    git clone https://github.com/harsxv/tinystatus.git
  3. Create a branch: 
    git checkout -b feature/your-feature-name
  4. Make your changes: Implement your feature or fix the bug.
  5. Commit your changes: 
    git commit -m "Description of your changes"
  6. Push to your fork: 
    git push origin feature/your-feature-name
  7. Create a Pull Request: Go to the original repository and click "New Pull Request".

Code Style

  • Follow the existing code style.
  • Write clear, concise commit messages.
  • Include comments where necessary.

Reporting Issues

If you find a bug or have a feature request, please create an issue on GitHub. Provide as much detail as possible to help us understand and address the issue.

Thank you for your contributions!