Skip to content

Latest commit

 

History

History
93 lines (59 loc) · 3.43 KB

README.md

File metadata and controls

93 lines (59 loc) · 3.43 KB
Raw

WELCOME TO WEBSTAR!

WEBSTAR is a pre-event of the upcoming MLH sponsored hackathon, Electrothon 5.0. Make sure to check out the website for more exciting events like this.

WEBSTAR welcomes contributions to our open-source projects on GitHub. Before contributing, please make sure to give a thorough read to the below-mentioned points:point_down:.

❓How the open source project will work:-

  • The competition will run for 10 days 📅.

  • We will be uploading a minimum of 5 Issues on this repository every 2 days.

  • Each Issue will belong to one of the 5 stages of difficulty level, with Level 1 being the least difficult, and Level 5 being the most challenging.

  • The contributor can choose to contribute on any of the issues. They are required to create a new branch from main branch and then submit a pull request for the same.

  • Add a comment under the Pull Request with the message Closes #<issue-no> to mark your contribution as valid.

For Contributions, we follow the “Fork-and-Pull” Git workflow:-

  • Fork the repo on GitHub
  • Clone the repo to your machine:desktop_computer:
  • Create a branch for your edits
  • Commit changes to your branch
  • Push 📤your work back up to your fork
  • Submit a Pull request so that we can review your changes.
  • Add the required closing comment to the Pull Request.

📌- Be sure to create branch from main branch only

📢 RULES AND REGULATIONS

📌The following points should be kept in mind while working on this project.

  • Each issue should be contained within a separate branch of its own. New branch can be created using

      git checkout main
  git checkout -b <branch-name>

  • Always use the main branch as the base branch.

  • The contributor should not make any changes to the main branch.

  • The new branch can be pushed to the remote repository using the following command:-

      git add -A
  git commit -m "commit message"
  git push -u origin <branch-name>

📌 CONTRIBUTION

❗ If a contributor submits their pull request without adding the necessary comment in the PR, their contribution will not be considered for reviewing.

📝POINTS ALLOCATION

📌 Each Level of Issue difficulty will carry the following marks:-

  • Level 1 - 10 marks
  • Level 2 - 20 marks
  • Level 3 - 30 marks
  • Level 4 - 40 marks
  • Level 5 - 50 marks

Getting a pull request submitted for an Issue will add marks to your name based on the corresponding difficulty level of the Issue. Time and quality of code will also be taken into consideration. Marks will be allotted in your respective Pull Request. Your total marks will be calculated at the end of this event.

🏆 The contributor who has the highest marks after 10 days will be declared as the winner.

🏆 All the participants will get a Certificate and winner will get Goodies !

📖RESOURCES

⭐ To make it easy for you, we have attatched the resources that will be used to solve the Issues down below:point_down:! May the force be with you!