Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
81 lines (61 loc) · 3.66 KB

CONTRIBUTING.md

File metadata and controls

81 lines (61 loc) · 3.66 KB

Contributing Guidelines

Thank you for your interest in contributing to OpenHack'25. This repository serves as the central hub for hackathon rules, resources, and project submissions.

🚀 Quick Start for Hackathon Submissions

For detailed step-by-step submission instructions, please see: 📋 SUBMISSION_TEMPLATE.md - Complete submission guide with Pull Request process

General Contribution Process

For Hackathon Projects:

  1. Fork this repository to your own GitHub account
  2. Follow the detailed process outlined in SUBMISSION_TEMPLATE.md
  3. Submit via Pull Request (GitHub Issues no longer accepted)

For Repository Improvements:

  1. Fork this repository
  2. Create a new branch for your improvement: git checkout -b improvement/description
  3. Make your changes (documentation updates, bug fixes, etc.)
  4. Commit with clear commit messages
  5. Submit a Pull Request describing your changesg Guidelines

Thank you for your interest in contributing to OpenHack’25. This repository serves as the central hub for hackathon rules, resources, and project submissions.

Contribution Process

  1. Fork this repository to your own GitHub account.
  2. Clone your fork to your local machine.
  3. Create a new branch for your project: git checkout -b team-name/project-name.
  4. Create a project folder in the root directory with your team name and project.
  5. Develop your project. Ensure your code is well-documented and includes testing.
  6. Commit your changes with clear and descriptive commit messages.
  7. Push your branch to your forked repository.
  8. Submit a Pull Request to the main repository with your project folder.

Project Requirements Summary

For complete submission requirements, see SUBMISSION_TEMPLATE.md

Essential Requirements:

  • Pull Request submission with proper title format
  • Working code that compiles and runs without errors
  • README.md with clear setup instructions
  • Proper project structure with organized folders
  • Dependencies listed in requirements.txt or package.json

Project Structure Example:

TeamName_ProjectName/
├── README.md (Setup and usage instructions)
├── src/ (Source code)
├── requirements.txt or package.json
└── main.py / app.js / index.html

Code Standards

  • Clean Code: Well-structured code with proper commenting
  • Error Handling: Basic error handling and validation
  • Documentation: Clear README with setup instructions
  • Functionality: Code should run without errors
  • Dependencies: All dependencies properly listed

Communication and Conduct

Important Links

Need help? Check SUBMISSION_TEMPLATE.md for detailed instructions or use Discussions for questions.