Skip to content

Latest commit

 

History

History
73 lines (47 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

73 lines (47 loc) · 2.25 KB

How to Contibute to this Repository

You can contribute in various ways:

General Contributions

  1. Star this repository to show your support.

  2. Create an issue with description about the competiton or program you want to add, and then wait for approval.

Adding a New Competition or Program

  1. If you are adding a new competition or program, follow these steps:

  • Add Description: Include a description of the competition, its official website, and a YouTube link (if available). List them in alphabetical order in the README file.

  • Modify Web Directory: Go to the web directory.

  • Edit script.js: Inside the web directory, locate the script.js file.

  • Update Object Array: In script.js, you will find an array containing objects. Add more events/competitions in object form within the array. Follow the structure of the object's attributes and naming conventions.

  • Create a Pull Request: Make a pull request with your changes and wait for a review.

Adding a Coding Contest or Hackathon

  1. If you are adding a coding contest or hackathon:

    • For coding contests, add the information to the coding contest folder's README.

    • For hackathons, add the information to the hackathon folder's README.

Creating a Pull Request

  1. Fork this repository to your own GitHub account.

  2. Clone your forked repository to your local machine:

git clone https://github.com/your_username/Competitions-and-Programs-List.git
  1. Navigate to the project directory:
cd Competitions-and-Programs-List

  1. Make Necessary Changes: Make the desired changes to the project.

  2. Create a new branch for your contribution:

git checkout -b your-branch-name
  1. Add, commit, and push your changes to your forked repository:
git add .
git commit -m "Your commit message"
git push origin your-branch-name

  1. Create a Pull Request to the main repository: Visit your forked repository on GitHub and click the "New Pull Request" button.

  2. Review and Merge: Your pull request will be reviewed by the project maintainers. Once approved, your changes will be merged into the main project.

Note: Before contributing, please create an issue first to get approval and assignment.