Skip to content

Latest commit

 

History

History
129 lines (99 loc) · 4.59 KB

README.md

File metadata and controls

129 lines (99 loc) · 4.59 KB
Raw

Contribute in making avva-website

This project aims to simplify and guide the way beginners make their first contribution to open source . If you are looking to make your first contribution. This repository is the right place to start.

Prerequisites:

Prerequisites:

  • Install git in your machine.
  • Have basic command line experiance.

Follow the given steps

  1. Fork this repository Click the button on top right corner labelled fork.

  2. Clone this repository using the link into your local machine. On the forked repo click the green button labelled code and copy the https url. Once it is copied open the terminal/cmd and type in the following code

     git clone "http url you just copied"

  3. Going to the required project directory

     cd Simple-web-Project

  4. Create a branch The best practise is to create another branch work on it and finally merge it . So after changing to project directory ,to creata new branch type in the foll code.

     git checkout -b your_new_branch_name

    for example :

    git checkout -b branch-2

  5. Add the necessary contribution and commit those contributions. To add the necessary contrbution that will get you accepeted refer contributiion.md file. After making the changes type in the below command this command will let you know which files have been modified.

     git clone

    Add those changes to the branch you just created using the below command.

    git add .

    Now commit those changes using the below command:

    git commiit -m "The changes that you done must be mentioned here"

  1. Push changes to github Push your changes using the below command:

    git push origin branch_name

    replace branch_name with the name of the branch you created earlier.

    For example:

    git push origin branch-2

  2. Submit your changes for review If you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button. Then if you want to mention anything about the changes type it in and finally submit the pull request.

Rules and Regulations

  1. Pull requests can be submitted to any opted-in repository on GitHub or GitLab

  2. The pull request must contain commits you made yourself.

  3. If a maintainer reports your pull request as spam, it will not be counted toward your participation in Hacktoberfest.

  4. If a maintainer reports behavior that’s not in line with the project’s code of conduct, you will be ineligible to participate.

  5. To get a shirt, you must make four approved pull requests (PRs) on opted-in projects between October 1-31 in any time zone.

  6. This year, the first 50,000 participants can earn a T-shirt.

examples of low quailty contributions

  • Pull requests that are automated e.g. scripted opening pull requests to remove whitespace / fix typos / optimize images.

  • Pull requests that are disruptive e.g. taking someone else's branch/commits and making a pull request.

  • Pull requests that are regarded by a project maintainer as a hindrance vs. helping.

  • Something that's clearly an attempt to simply +1 your pull request count for October.

  • Last but not least, one pull request to fix a typo is fine, but 5 pull requests to remove a stray whitespace is not.

What is Open Source

Open source refers to a software program or platform with source code that is readily accessible and which can be modified or enhanced by anyone.

Open source access grants users of an application permission to fix broken links, enhance the design, or improve the original code.

Pros of Open source

  • Initial cost
  • Reliability
  • Longevity
  • Security
  • Flexibility

Cons of Open source

  • Long-term cost
  • Support
  • Orphan software
  • Security
  • Usability

Some Open Source organistaions

  • Blender
  • Mozila Firefox
  • VLV Media player
  • Python Django

Some Open source organisations

  • Hacktoberfest
  • GSOC

More about Open source

Open-source software (OSS) is computer software that is released under a license in which the copyright holder grants users the rights to use, study, change, and distribute the software and its source code to anyone and for any purpose. Open-source software may be developed in a collaborative public manner. Open-source software is a prominent example of open collaboration, meaning any capable user is able to participate online in development, making the number of possible contributors indefinite. The ability to examine the code facilitates public trust in the software.