Skip to content

Latest commit

 

History

History
80 lines (60 loc) · 2.94 KB

CONTRIBUTION.md

File metadata and controls

80 lines (60 loc) · 2.94 KB
Raw

Hack The Trivia Hackathon - Contribution Guidelines

Welcome to Hack The Trivia! We are excited to have you participate in our hackathon. Before you start contributing, please read and follow these guidelines to ensure a smooth and organized submission process.

Table of Contents

  1. General Information
  2. Tracks
  3. Submission Process
  4. Project Folder Structure
  5. Naming Convention
  6. Pull Request (PR) Guidelines
  7. Code of Conduct

General Information

Tracks

  • Track 1: Web3 & Blockchain
  • Track 2: Social Impact & Healthcare
  • Track 3: Gaming & AR/VR/MR
  • Track 4: Technology & Software Development
  • Track 5: Open Innovation

Submission Process

  1. Fork the Hack The Trivia GitHub repository.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your project: git checkout -b team-name-project.
  4. Develop your project within the designated track folder.
  5. Follow the Project Folder Structure guidelines.
  6. Commit your changes and push them to your forked repository.
  7. Submit a pull request to the main repository's main branch.

Project Folder Structure

Please organize your project folder according to the following structure:

/
  /Gaming & AR-VR-MR
    /Team <TEAM_NAME>
      /<PROJECT_FILES>
  /Open Innovation
    /Team <TEAM_NAME>
      /<PROJECT_FILES>
  /Social Impact & Healthcare
    /Team <TEAM_NAME>
      /<PROJECT_FILES>
  /Technology & SOftware Dev
    /Team <TEAM_NAME>
      /<PROJECT_FILES>
  /Web3 & Blockchain
    /Team <TEAM_NAME>
      /<PROJECT_FILES>

Replace <TEAM_NAME> with your team's name and <PROJECT_FILES> with the actual files and folders of your project.

Naming Convention

  • Team folders should be named as "Team <TEAM_NAME>" (e.g., "Team Awesome").
  • Use a clear and concise name for your team & as well as for your project (The name must justify the project aim & whereabouts) .

Pull Request (PR) Guidelines

  • Ensure your pull request is detailed and includes information about your project, the track you are participating in, and any specific instructions for testing.
  • Mention any dependencies or requirements in the pull request.
  • Clearly state if there are any special configurations needed to run your project.

Code of Conduct

By participating in this hackathon, you agree to abide by the Hack The Trivia Code of Conduct. Please ensure that your contributions and interactions adhere to the guidelines outlined in the code of conduct.

Happy hacking! If you have any questions, feel free to reach out to the organizers or create an issue in the repository.