Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (41 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

68 lines (41 loc) · 2.5 KB
Raw

Contributing to The Exicon Project

Thank you for your interest in The Exicon Project!

This is a community effort to build and maintain the F3 exercise lexicon (Exicon) and terminology. Our mission is to help Qs share workouts, learn F3 language, and grow the traditions of the F3 Nation.

What is the Exicon?

The Exicon is named exercises used in F3 workouts, each with instructions, stories, and traditions. We also maintain a lexicon of F3 terminology - from PAX to Qs to beatdowns. This helps Qs bring consistency and fun to workouts while honoring F3 culture.

How to Get Involved

There are several ways to contribute to The Exicon Project, whether you're a developer, F3 Q, or community member passionate about fitness and open source.

1. Contribute Exercises

  • Submit new exercises: Share your favorite workout moves and the stories behind them
  • Update existing entries: Help improve descriptions, add videos, or correct information
  • Add aliases: Many exercises are known by different names across regions — help us capture that diversity

2. Join the Discussion

Connect with other PAX on our official Discord: https://discord.gg/qUKbvs7cx2

This is where we discuss everything from exercise submissions to technical development and long-term vision.

3. Development & Technical Contributions

  • Report bugs: Found something not working? Open an issue
  • Suggest features: Have ideas for improving the platform? We'd love to hear them
  • Code contributions: Help us build and improve the platform (see development setup below)

4. Watch this Repo

Use GitHub's Watch feature to stay updated on new issues, discussions, and development progress.

Development Setup

If you're interested in contributing code to the project:

  1. Fork this repository
  2. Clone your fork locally
  3. Install dependencies: pnpm install
  4. Start the development server: pnpm dev
  5. Make your changes and submit a pull request

Exercise Submission Guidelines

When contributing exercises, please include:

  • Exercise name and any known aliases
  • Clear instructions for performing the exercise
  • Video demonstration (if available)
  • Story or origin behind the exercise (optional but encouraged)
  • Appropriate tags (body parts, equipment, difficulty, etc.)

Code of Conduct

Please be respectful and supportive. This project is rooted in the spirit of F3 — leave no man behind, but leave no man where you found him.