Opencode Collaborative 2023

Like us on Facebook

About us

OpenCode is a month long open source program organised by GeekHaven IIIT Allahabad. OpenCode attracts talent from all over the world. People contribute to various open source projects. We welcome everyone to experience the awesome event and win exciting prizes .

Requirements:

• GitHub Account
• Git

Setting up git:

• Download and install the latest version of Git.
• Set your username in Git.
• Set your commit email address in Git.

Adding a mentor

To add a mentor open mentors.json and please maintain the following format EXACTLY (replacing values where indicated):

     {

        "name" : "Mentors Name",
        "imageurl" : "mentor/image.jpg",
        "about" : "Hello I'm a web developer",
        "facebook" : "url",
        "github" : "url",
        "twitter" : "url"
     }

IMPORTANT:

• All images must be optimized before uploaded to the repo via commit or PR.
• The images should be of square resolution.
• If you do not want to include social media accounts, leave the field empty "facebook":"".

Adding yourselves to participant section

To add yourself to student section you need to open the file participants.json and please maintain the following format EXACTLY (replacing values where indicated):

   {

       "name" : "Name",
       "imageurl" : "contestant/avatar.jpg",
       "about" : "Hello I'm a web developer",
       "college" : "My college",
       "facebook" : "url",
       "github" : "url",
       "twitter" : "url",
       "referral" : "who refered you?"
    }

IMPORTANT:

• If you do not want to include social media accounts, leave the field empty "facebook":"".
• While working with JSON, check the file using JSON Lint before opening pull request

Contributing

Getting started

We will follow the official GitHub documentation for setting up the repo.

• Forking and cloning the repository

  Link to GitHub Docs

  By forking a repository you create your own copy of the project and make your changes there. Cloning a project means that you are setting up the project on your local system.

• Syncing a fork

  Link to GitHub docs

  We keep our fork in sync to the original repository so that our copy of the project has the latest changes from the original project.

• Making changes to project and committing a change

  Link to docs

  Committing means making changes to the project and adding your changes to the GitHub.

• Making a pull request

  Link to docs

  • Pull request means submitting your changes to the original project for the review. Once the maintainers of the project feel that your changes are appropriate then your pull request will be merged.

• Add relevant commit message in the pr, mention issue number and live link to comment while making pr.
• Note: In case you feel any issue during setting up the project or using git, don't hesitate to ask us on our slack channel. We will help you out.

Installing Node.js

To install Node.js on your local machine, follow these steps:

• Download the Node.js installer from the official website.
• Run the installer and follow the prompts to complete the installation.
• To verify that Node.js has been successfully installed, open a terminal window and type node -v. This should print the current version of Node.js that you have installed.

Running the project

• Clone the repository to your local machine using git clone https://github.com/[USERNAME]/[REPO_NAME].git
• Navigate to the root directory of the repository using cd [REPO_NAME]
• Install the necessary npm packages by running npm install. This will install all of the packages listed in the dependencies section of the package.json file.
• Run the project using npm start. This will start the application and should display a message in the terminal indicating that the server is running.
• Control click on the link which the terminal will provide you to view your site.

Guidelines and Best practices

Please help us follow the best practice to make it easy for the reviewer as well as the contributor. We want to focus on the code quality more than on managing pull request ethics.

• People before code: If any of the following rules are violated, the pull-requests must not be rejected. This is to create an easy and joyful onboarding process for new programmers and first-time contributors.

• Single commit per pull request and name the commit as something meaningful, example: Adding <-your-name-> in students/mentors section.

• Reference the issue numbers in the commit message if it resolves an open issue. Follow the pattern Fixes #

• Provide the link to live gh-pages from your forked repository or relevant screenshot for easier review.

• Pull Request older than 3 days with no response from the contributor shall be marked closed.

• Do not make PR which is not related to any issues. You can create an issue and solve it once we approve them.

• Avoid duplicate PRs, if need be comment on the older PR with the PR number of the follow-up (new PR) and close the obsolete PR yourself.

• Be polite: Be polite to other community members.

• Communicate: Whether you are working on a new feature or facing a doubt please feel free to ask us on our slack channel. We will be happy to help you out.

Happy Coding ✌️

Collaborative-Web-2023