Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

53 lines (37 loc) · 2.13 KB

Contributing to Mockly

🎉 Welcome, Hacktoberfest Contributors! 🎉
We’re excited that you’re here to help make Mockly even better. Whether it’s fixing bugs, adding new features, or improving documentation, we’re thrilled to have you onboard.

Getting Started

  1. Fork the Repo: Click the "Fork" button on the top-right of the repository page.
  2. Clone the Fork:
git clone https://github.com/YOUR-USERNAME/mockly.git 
cd mockly
  1. Install Dependencies:
npm install
  1. Create a New Branch:
git checkout -b feature/your-feature-name

How to Contribute

  • Check Existing Issues: We have a list of issues tagged for Hacktoberfest that you can start with. Feel free to pick one or suggest your own improvements.
  • Create an Issue: If you find a bug or have a feature request that isn’t listed, open a new issue and explain the problem or idea.
  • Submit Pull Requests (PRs): Once you’ve made your changes, push your branch to your fork and submit a pull request to the main branch.

Areas to Contribute

Here are some ideas for contributions:

  • Fix Bugs: Check for issues like performance problems (e.g., canvas flickering).
  • Add Features: More export options, custom screen sizes, UI improvements, etc.
  • Improve Documentation: Help make our docs clearer and more beginner-friendly.
  • Code Review: Provide feedback on others’ PRs and help keep the project quality high.

Hacktoberfest Guidelines

To ensure your PRs count toward Hacktoberfest:

  • Your pull request must be merged, approved, or tagged with hacktoberfest-accepted by a maintainer.
  • Spammy or low-quality PRs will not be accepted (we’re all here to learn and improve together!).

Code of Conduct

Be respectful, kind, and encouraging. We’re here to support each other and grow as a community. Please read our Code of Conduct before contributing.

Thank You!

Your contributions mean the world to us! Let’s build something great together. Happy Hacktoberfest! 💻🎃

If you have any questions, feel free to open an issue or reach out directly. 😊