First of all, thank you for considering contributing to our project! We’re thrilled to have you here, and we're excited to work together during Hacktoberfest 2024.
Whether you’re new to open source or a seasoned contributor, this guide will help you make your first contribution easily.
Hacktoberfest is a month-long celebration of open source software, organized by DigitalOcean and open to everyone in the global community. It encourages participation in the open-source community, which grows stronger by the contributions made by you!
Register at Hacktoberfest (if you haven't already).
Submit at least 4 Pull Requests (PRs) to any open-source repository between October 1 and October 31, 2024.
Contributions can be any meaningful pull requests – bug fixes, features, improvements, or even fixing typos!
⚠️ Note: PRs that are spammy or automated may get flagged and disqualified from Hacktoberfest.
Follow these steps to contribute to Wonder-nest. Don’t worry if you’re new—every contribution matters!
Click the Fork button at the top-right corner of this page to make a copy of this repository under your GitHub account.
Open your terminal and run the following command to clone the forked repo:
bash
Copy code
Navigate into the project directory and create a new branch for your contribution:
bash Copy code cd REPO-NAME ###git checkout -b your-branch-name Name your branch something meaningful, like fix-typo or add-feature.
Make the necessary changes in your branch. You can fix bugs, add features, update documentation, or improve code quality. If you're new and not sure where to start, check out the Issues tab to find issues labeled good first issue or Hacktoberfest!
After making changes, commit them with a clear and descriptive message: bash Copy code git add .
Push your changes to your forked repository: bash Copy code
Go to the original repository you forked and click the New Pull Request button. Compare your branch with the original repository’s main branch. Write a detailed description of what you've done, and submit the Pull Request!
Not sure what to work on? Here are some areas where your contribution would be valuable:
New Features: Have a feature in mind? Open a discussion under Issues or contribute directly if it’s small.
UI/UX Improvements: Have a knack for design? Suggest improvements for our web interface or user experience.
To make it easier for you to contribute, we’ve labeled issues based on difficulty and importance. Here’s what the labels mean:
We aim to keep the codebase clean and organized, so here are a few guidelines for submitting a PR:
Provide a clear description of what you’ve done in the PR description. Reference any related issues in the PR body (use #issue-number to link them). Ensure your code follows the project’s coding standards (linting, formatting, etc.). Update documentation if your changes require it. Don't hesitate to ask for help! We're here to guide you if you're unsure about something.
Please note that this project is governed by a Code of Conduct. By participating, you agree to uphold this code.
We want to foster an inclusive, welcoming environment where everyone feels safe and respected. Treat others with kindness, and always be polite and respectful when discussing ideas or providing feedback.
If you need help at any stage, feel free to: Open a discussion under the Issues tab. Ask questions in your PR description. Tag the maintainers with @username in GitHub discussions or issues. We’ll do our best to respond as quickly as possible!
We appreciate every contribution—no matter how small. Thank you for taking the time to improve [Project Name]! We can’t wait to see what you build.
📎 Useful Links: Hacktoberfest Official Website How to Create a Pull Request Markdown Guide Let’s make this Hacktoberfest the best one yet! 🌟