Rules and Regulations for Documentation
Rules and Regulations for Documentation
1. Documentation Requirements
Every project must have a detailed and structured documentation file named README.md in
the root of the repository. This file should contain the following sections:
a. Project Overview
b. Technology Stack
Clearly list all the technologies and tools used in the project (e.g., React.js, Node.js,
MongoDB, Puppeteer, etc.).
Mention versions of major tools (e.g., React 18, Node.js 16).
c. System Requirements
e. Features Explanation
f. Usage Instructions
Explain how users (both job seekers and employers, in this case) can use the platform.
Include a demo walkthrough:
o How a job seeker creates a resume, searches for jobs, and applies.
o How an employer posts job openings and reviews applications.
Provide a link to the live project.
g. Code Structure
h. Testing
j. Future Enhancements
Acknowledge team members, mentors, and any third-party tools or libraries used.
l. License
Specify the license under which the code is shared (e.g., MIT License).
To make the project accessible, it must be hosted live on a suitable platform. Below are the
rules for deployment:
a. Hosting Platforms
b. Deployment Steps
Include clear instructions in the documentation on how to deploy the project on the
chosen platform.
Share the live project URL prominently in the README.md.
c. Demo Video
Create a short demo video (2–5 minutes) showcasing the live project and its key
functionalities.
Upload the video to YouTube and include the link in the documentation.
a. Repository Setup
c. README.md
d. GitHub Workflow
Follow proper pull request and code review processes if working in a team.
Use GitHub Issues for tracking bugs and feature requests.
e. Public Access
4. Submission Guidelines
5. General Rules
Originality: Ensure the project is original and built during the hackathon/webathon
duration.
Time Management: Complete the project within the allocated timeframe.
Team Collaboration: Work collaboratively, ensuring all members contribute.
No Plagiarism: Any instance of plagiarism will lead to disqualification.
6. Judging Criteria
7. Post-Event