Giter VIP home page Giter VIP logo

hello-open-source's Introduction

Hello Open Source 🖐️

A repository to learn about open source code contributions flow (for beginner only)

🌎 Translations

Sort by alphabet

❓ How to contribute

  • Fork this repo, read how to fork repo
  • Create branch with your github username, ex: add-mazipan.js. Never use the master branch to create PR. read how creating branch
  • Add your first file with file name github_username.js on the peoples/ directory in that branch.
  • Add code with your identity, ex:
module.exports = {
  name: 'YOUR_NAME',
  github: 'XXX',
  email: '[email protected]',
  twitter: '@xxx',
  facebook: 'xxx',
  linkedin: 'in/xxx'
};
  • Create Pull-Request to master branch in this repository, read how creating PR
  • Don't forget to give 🌟 in this repository, you can check in stargazers page
  • You should follow github @mazipan
  • I will check your PRs and will add invalid label and close the PRs that not follow the steps
  • Have fun and welcome to open source world.
  • Keep in mind, quality is always number one when creating PRs.

💰 Is this data collection?

No, this is for learning purpose only.

🥶 Do I need to attach my real name?

No, just put any data. Non-sense, we just want to learn a flow to contribute in open source code.

🙈 Do it with your own risk

We don't collect the data, but there is chance for other people to abuse your data that is submitted here. Please do it with your own risk, we don't protect your data.

⤵️ How do I retrieve someone's data?

git clone https://github.com/mazipan/hello-open-source # clone the repo
cd hello-open-source # cd into the repo
node index.js caxvis # will return this person's named caxvis to you

🗑️ How to remove my data?

Remove all data

yarn purge

You can specify a name (or more) to remove only those file(s)

yarn purge joe-bob kitty-luvr73

❌ I will purge the data periodically (weekly, via a Cronjob), so your data will be deleted periodically.

🚶 Next Step

This repo is only introduce you to open source code contribution flow. After following all steps here, we expect you will have a basic knowledge in how to fork repository, how a git branch works, how to create a good pull request and other basic things to make your next contribution in open source code 🥳.

👉 Don't stop here, keep contribute to open source code


Copyright © 2018 Irfan Maulana

hello-open-source's People

Contributors

mazipan avatar drepram avatar ninariccimarie avatar blackmenthor avatar actions-user avatar itsmejustinc avatar prayatna avatar sinsovannmony avatar senghout016 avatar dubsy69 avatar poomchaio avatar nickjlee avatar nauhcnoohc avatar arrivera avatar piharpi avatar davidmartinezfl avatar coolxer avatar xtbe avatar tbanov avatar resmall avatar tarunsingal1409 avatar batunii avatar sulaiman-kc avatar souvik48 avatar imsonujangra avatar soniazaldana avatar sonam81 avatar snlagr avatar somilg050 avatar krsomala avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.