Welcome to Wayne Capitals, a GitHub organization where code meets the dark and mysterious world of Gotham. Inspired by Batman lore, every repository under Wayne Capitals follows a strict code of discipline, just like the Dark Knight himself.
-
Batman References: Every repository must have a reference to Batman lore, whether in the repository name, README, or project structure. Creativity is encouraged!
-
Professionalism & Quality: Like Bruce Wayne's enterprises, we maintain high standards of professionalism, structure, and clean code practices.
-
Collaboration & Vigilance: Work together as a league, review code thoroughly, and ensure every contribution adds value.
-
Code of Conduct: Maintain respect for fellow contributors, engage in meaningful discussions, and keep contributions ethical and constructive.
To maintain consistency and quality across our projects, we follow a structured coding standard:
Variables & Functions: Use camelCase (e.g., batSignalStrength, detectJokerLocation())
Constants: Use UPPER_SNAKE_CASE (e.g., GOTHAM_NIGHT_MODE)
CSS Classes: Use lowercase-with-hyphens (e.g., .dark-knight-theme, .wayne-tech-button)
File Names: Use kebab-case for frontend files and PascalCase for React components (e.g., batman-utils.js, JokerTracker.jsx)
Every repository should reflect a reference to Batman lore. Examples:
gotham-guardian (for security-related projects)
batcave-database (for databases and backend projects)
wayne-tech-ui (for frontend UI libraries)
arkham-simulator (for simulations and AI-driven projects)
Descriptive Messages: Use clear and meaningful commit messages (e.g., Fix: Improved Batarang throwing accuracy algorithm)
Prefixes:
Feat: for new features
Fix: for bug fixes
Refactor: for code restructuring
Docs: for README or documentation updates
Chore: for minor changes and maintenance
Begins for first commit
Every PR should be reviewed by at least one other contributor.
Provide clear descriptions and references to related issues.
Link PRs to relevant GitHub Issues when applicable.
Follow the Wayne Capitals Code of Honor: clean, efficient, and readable code.
Interested in becoming a part of Wayne Capitals? Follow these steps:
-
Fork & Clone a repository you’d like to contribute to.
-
Follow the code guidelines while making changes.
-
Open a pull request with a detailed description.
-
Ensure your changes align with our Gotham-standard coding practices.
For any queries, contact Alfred (or the repo maintainers) via GitHub Issues.
"It’s not who we are underneath, but what we do that defines us." - The Dark Knight