Code Monkey home page Code Monkey logo

hello-open-source's Introduction

Hello Open Source ๐Ÿ–๏ธ

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

๐ŸŒŽ Translations

โ“ 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 only for learning purpose about git flow and open source contribution process.

๐Ÿฅถ Do I need to attach my real name?

No, just put any data. Non-sense, we just wanna learn about open source contribution.

โคต๏ธ 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 purge the data

Purge all data

yarn purge

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

yarn purge joe-bob kitty-luvr73

โŒ I will purge the data periodically (monthly, via Travis Cronjob), so please expect your data will be deleted anytime

๐Ÿ™ˆ 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.

๐Ÿšถ Next Step

This repo is for introduce to open source code contribution flow. After follow all steps, we expect you will know how to fork repository, how branching works, how to create good pull request and other things about contribution to open source code ๐Ÿฅณ.

๐Ÿ‘‰ Don't stop here, please keep contribute to any open source code ๐Ÿ™.


Copyright ยฉ 2018 Irfan Maulana

hello-open-source's People

Contributors

arrivera avatar batunii avatar blackmenthor avatar codevee avatar davidmartinezfl avatar drepram avatar imsonujangra avatar itsmejustinc avatar krsomala avatar mazipan avatar nickjlee avatar ninariccimarie avatar piharpi avatar poomchaio avatar prayatna avatar resmall avatar senghout016 avatar silviucanton avatar sinsovannmony avatar snlagr avatar somilg050 avatar sonam81 avatar soniazaldana avatar sulaiman-kc avatar tarunsingal1409 avatar tbanov avatar tomfrink avatar ulul avatar valdemirfilho avatar vaticori avatar

Watchers

 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.