Skip to content

docs(hacktoberfest): add comprehensive Hacktoberfest welcome guide #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(hacktoberfest): add comprehensive Hacktoberfest welcome guide #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions HACKTOBERFEST.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
Hacktoberfest 2025: Welcome to ExerciseDB API!
Welcome to the ExerciseDB API project and thank you for joining us in Hacktoberfest 2025! This open-source project provides a comprehensive, fast, and developer-friendly fitness exercise database with over 5,000 structured exercises, and your contributions help make it even better.

Why Your Contribution Matters?
This project empowers developers, health platforms, and fitness enthusiasts by providing detailed exercise data complete with instructions, images, videos, and muscle targeting information. By contributing, you help maintain quality, improve documentation, fix bugs, and add new features to make ExerciseDB even more reliable and user-friendly.

Your pull requests are valuable because they:
Help keep this database accurate, fresh, and scalable.
Improve developer experience for anyone building fitness and wellness apps.
Enhance accessibility and data richness to support personalized training tools.

Getting Started - A Friendly Guide:
Before you start, please follow these simple steps to ensure your contributions fit smoothly into the project workflow:
Read the project’s Code of Conduct and Contribution Guidelines to align with our community values.
Fork this repository, then clone your fork locally.
Create a new branch from the latest main or dev branch using kebab-case naming, for example:
1234-fix-exercise-instruction
1234-add-new-exercise-data
Write clear, focused commits with meaningful messages.
Keep your code clean and test any new features or fixes.
Follow consistent formatting and style to maintain readability.

Pull Request Best Practices:
When opening a pull request:
Use a descriptive title that clearly states what you changed.
Provide a detailed description explaining why the change is necessary.
Reference related issues or features you’re addressing.
Ensure all tests pass and lint checks succeed before submitting.
Be responsive to maintainers’ feedback and ready to make improvements.

Friendly Reminders:
Aim for quality over quantity—well-crafted PRs increase the chance of merging.
Check existing issues, especially those tagged good-first-issue or help wanted, to find contributions suited to your skill level.
Ask questions and communicate actively if you need help—this community thrives on collaboration.
Be respectful and patient during reviews; we all work together to build something great.

Thank You for Contributing!
Your participation not only improves this robust fitness exercise database but also fuels the open-source spirit that drives innovation. We encourage everyone—from first-timers to seasoned developers—to share their skills and creativity here.

Happy Hacktoberfest 2025! Let’s build fitness tools that empower health and well-being worldwide.