Thank you for considering contributing to our Repository! We’re excited to collaborate with you during Hacktoberfest 2024.
Whether you're new to open source or an experienced developer, this guide will help you make a smooth contribution to the project.
Hacktoberfest is an annual celebration of open source, organized by DigitalOcean. It's a month-long event open to everyone in the global community, encouraging contributions that strengthen the open-source ecosystem.
- Register for Hacktoberfest here (if you haven't already).
- Submit at least 4 Pull Requests (PRs) to any open-source repository between
October 1andOctober 31, 2024. - Contributions can be bug fixes, features, documentation improvements, or even small changes like typo corrections.
Follow these steps to get started with contributing to our project.
Do not delete or modify existing files unnecessarily.
Ensure your files have the correct extensions (e.g., .html, .css, .js).
Place your files inside the appropriate folder structure. Do not add files outside the designated folder.
Be open to feedback and willing to make changes if needed.
Don’t forget to ⭐ star this repository if you like the project!
Click the Fork button at the top-right corner of this page to create a copy of this repository under your GitHub account.
Clone your forked repository locally using the following command:
git clone https://github.com/YOUR-USERNAME/REPO-NAME.gitNavigate into the project directory and create a new branch for your contribution:
cd REPO-NAME
git checkout -b your-branch-nameName your branch something relevant, such as fix-bug, add-feature, etc.
Make the necessary changes in your branch. You can:
- Fix bugs
- Add new features
- Improve the documentation
- Refactor code
If you’re new to the project, check the Issues tab for good first issue or Hacktoberfest labels to find beginner-friendly issues.
After making changes, commit them with a clear and descriptive message:
git add .
git commit -m "A brief description of the changes"Push your changes to your forked repository:
git push origin your-branch-nameGo to the original repository and click on New Pull Request. Compare your branch with the main branch of the original repo.
Write a detailed description of what you’ve done and submit the pull request.
Not sure where to start? Here are some suggestions:
- Bug Fixes: Check the Issues tab for any bugs reported by the community.
- New Features: If you have a feature in mind, open a discussion under Issues or contribute directly.
- Documentation: Improvements to documentation are always welcome.
- Code Refactoring: Help us improve code readability and quality.
- UI/UX Enhancements: Suggest or implement improvements to the design or user experience.
Here’s what some of our issue labels mean:
- good first issue: Ideal for first-time contributors.
- bug: Issues related to bugs or malfunctions.
- enhancement: Suggestions for new features or improvements.
- documentation: Issues related to improving documentation.
When submitting a PR, please keep the following guidelines in mind:
- Provide a clear description of what you’ve done.
- Reference any related issues using
#issue-number. - Ensure your code follows the project's coding standards.
- Update documentation if necessary.
- Ask for help if needed—feel free to reach out via the issue or PR.
We are committed to fostering a welcoming and inclusive environment. Please follow our [Code of Conduct] to ensure respectful and constructive communication.
If you need assistance at any point, feel free to:
- Open a discussion under the Issues tab.
- Ask questions in your PR description.
- Tag the maintainers in GitHub discussions or issues.
We’re here to support you!
We appreciate every contribution, no matter the size. Thank you for your time and effort in improving the Repository. We’re excited to see what you create!