Coder Social home page Coder Social logo

guestbook's Introduction

THE OPENSAUCED GUESTBOOK

This guestbook is a place for people who have taken OpenSauced's Intro to Open Source course to take their first steps into contributing to open source.

Getting Started

First, you'll want to have Node.js installed. You can do this by going to nodejs.org and downloading the latest version. Then, follow these steps:

  1. Fork this repository.

  2. Clone your forked repository to your computer.

  3. Run npm install to install the dependencies.

  4. Create a new branch.

    The best practice for open-source contributors to work on changes is in a new branch to isolate them from the main branch.

    Run this command on your terminal to create a new branch. You can name the branch anything you want.

    git checkout -b branch-name
  5. Add yourself to the guestbook.

    There are two ways you can complete this activity:

    • Using the CLI tool.
    • Manually editing the .all-contributorsrc file

    Although adding yourself to the guestbook with the CLI tool is simpler, we recommend you to manually editing the file to get more experience adding and committing your changes, creating pull requests and pull request reviews. Below, you'll find the directions for each method:

    CLI Tool

    • Run npm run contributors:add in your terminal.

      Follow the instructions to add yourself to the guestbook. After you finish and click enter, you must click enter again to confirm your choices.

    Manual Addition

    • Open the .all-contributorsrc file.

    • Go to the last contributor in the contributors array.

    • Add a comma after the last closing curly bracket ( }, ).

    • Copy and paste the template below:

      {
         "login": "",
         "name": "",
         "avatar_url": "",
         "profile": "",
         "contributions": []
      }
    • Add yourself manually to the guestbook by updating this information:

      • login: Your GitHub's username.

      • name: Your name.

      • avatar_url: URL to your avatar on GitHub.

        In your browser, copy and paste the link of your GitHub profile, append .png at the end β€” for example, https://github.com/USER_NAME.png β€” and click enter. Copy and paste the link here.

      • profile: Link to your website (if you include it in your GitHub profile) or your GitHub profile.

      • contribution: Type of your contributions.

        Refer to the type (in the first column) in this emoji key and contribution types to fill this value.

        The result would be like this:

        {
          "login": "github-username",
          "name": "User Name",
          "avatar_url": "https://avatars.githubusercontent.com/u/xxxxxxxx?v=x",
          "profile": "URL link",
          "contributions": [
          "question",
          "blog",
          "code"
          ]
        }

      Remember to add a comma after the quotes, except for the last one in the array and the last closing curly bracket.

  6. Run npm run contributors:generate in your terminal to generate the guestbook on the README.

  7. Add and commit your changes by running this command:

    git commit -am "Your message"

    Change "Your message" to your own message. For example, "Add Alice to the guestbook".

    You can skip this step (7) if you use the CLI tool to add yourself to the guestbook.

  8. Run git log to check if you have committed your changes. Press Q to close the log.

    If you add yourself using the CLI tool, it automatically adds and commits your changes. So you will see this automated commit message:

    docs: add @your_username as a contributor
  9. Push the commit to your forked repository with this command:

    git push -u origin branch-name
  10. Go to your forked repository on GitHub and create a pull request.

Congratulations on your first contribution! πŸŽ‰

You can add this contribution to your OpenSauced resume and profile as outlined in the course!


🀝 Contributing

All contributors are required to abide by our Code of Conduct. Please follow the Readme directions for contributing.

Contributors

All Contributors

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Tejas Kumar
Tejas Kumar

pszymaniec
pszymaniec

πŸ“ πŸ’» πŸ–‹ πŸ“– πŸ’‘ πŸ”¬ 🌍 βœ… πŸ›
BekahHW
BekahHW

πŸ’¬ πŸ”Š πŸ“ πŸ’» πŸ–‹ πŸ“– πŸ“‹ πŸ’‘ πŸ€” πŸ§‘β€πŸ« πŸ“† πŸ“£ πŸ”¬ πŸ‘€ πŸ“’ ⚠️ βœ… πŸ“Ή
ValarieOyieke
ValarieOyieke

πŸ› πŸ’» πŸ’‘ πŸ‘€ πŸ““
Shirene Kadkhodai Boyd
Shirene Kadkhodai Boyd

️️️️♿️ πŸ’¬ πŸ“ πŸ› πŸ’» πŸ–‹ πŸ”£ 🎨 πŸ“– πŸ€” 🚧 πŸ§‘β€πŸ« πŸ”Œ πŸ”¬ πŸ‘€ πŸ“’ ⚠️ πŸ”§ πŸ““
Shelley McHardy
Shelley McHardy

πŸ’¬ πŸ’» πŸ“– πŸ“‹ πŸ§‘β€πŸ« πŸ‘€ βœ…
jmslynn
jmslynn

️️️️♿️ πŸ’»
Ayu Adiati
Ayu Adiati

πŸ’¬ πŸ“ πŸ’» πŸ–‹ πŸ“– πŸ’‘ πŸ§‘β€πŸ« πŸ“’ 🌍
Clifford Mapesa
Clifford Mapesa

️️️️♿️ βœ…
Edgar Figueroa
Edgar Figueroa

πŸ’» πŸ”£ πŸ“– πŸ”¬ πŸ›‘οΈ ⚠️ 🌍
Mark Anel Cabonilas
Mark Anel Cabonilas

️️️️♿️ πŸ’¬ πŸ“ πŸ’» πŸ”£ πŸ“– πŸ€” πŸ”§
Dan Eisenhut
Dan Eisenhut

πŸ’»
Jay Knowles
Jay Knowles

πŸ“ πŸ’»
BIROUE ISAAC
BIROUE ISAAC

πŸ’» 🌍
Alarezomo Osamuyi
Alarezomo Osamuyi

️️️️♿️ πŸ”Š πŸ§‘β€πŸ« πŸ““ πŸ’¬ ⚠️ 🌍 πŸ“’
Sushant Sharma
Sushant Sharma

πŸ“–
Ali Shata
Ali Shata

πŸ“ πŸ’» πŸ–‹ πŸ”£ 🎨 πŸ“– πŸ“‹ πŸ’‘ πŸ€” πŸ“£ πŸ”¬ πŸ‘€ πŸ“’ βœ…
Anthony Nanfito
Anthony Nanfito

πŸ’»
Kin NG
Kin NG

πŸ“ πŸ› πŸ’» 🎨 πŸ“– πŸš‡ πŸ‘€
zh-hadi
zh-hadi

️️️️♿️ πŸ’¬ πŸ”Š πŸ“ πŸ› πŸ’Ό πŸ’» πŸ–‹ πŸ”£ 🎨 πŸ“– πŸ’‘ πŸ’΅ πŸ€” πŸš‡ 🚧 πŸ§‘β€πŸ« πŸ“¦ πŸ”Œ πŸ“† πŸ“£ πŸ”¬ πŸ‘€ πŸ›‘οΈ πŸ“’ ⚠️ πŸ”§ 🌍 βœ… πŸ““ πŸ“Ή
Santiago Montoya RendΓ³n
Santiago Montoya RendΓ³n

πŸ’¬ πŸ’» πŸ”£ πŸ“– 🚧
Atreay  Kukanur
Atreay Kukanur

πŸ’¬ πŸ’» πŸ–‹ 🎨 πŸ“– πŸ“‹ πŸ€” πŸ“£ πŸ”¬ πŸ““
Ms. Suldana
Ms. Suldana

️️️️♿️
Prabhat Bhagel
Prabhat Bhagel

πŸ”Š πŸ’» 🎨
Kelvin Yelyen
Kelvin Yelyen

πŸ’» πŸ–‹ 🎨 πŸ› πŸ“– πŸ€” πŸ“† πŸ”¬ ⚠️
Fatima-Abdirashid
Fatima-Abdirashid

️️️️♿️ πŸ’¬ πŸ”Š πŸ“ πŸ› πŸ’Ό πŸ’» πŸ–‹ πŸ”£ 🎨 πŸ“– πŸ“‹ πŸ’‘ πŸ’΅ πŸ” πŸ€” πŸš‡ 🚧 πŸ§‘β€πŸ« πŸ”¬ πŸ‘€ πŸ›‘οΈ πŸ“’ ⚠️ πŸ”§ 🌍 βœ… πŸ““ πŸ“Ή
Iqra-Issack
Iqra-Issack

πŸš‡ 🚧
muniir1
muniir1

️️️️♿️
Anyanime Benson
Anyanime Benson

πŸ’» πŸ“–
Mohamed Ali Nor
Mohamed Ali Nor

πŸ“£
Folarin Raphael
Folarin Raphael

️️️️♿️ πŸ’¬ πŸ“ πŸ’» πŸ“– 🚧 πŸ“¦ πŸ”Œ πŸ“† πŸ“£ πŸ‘€ ⚠️ 🌍 πŸ““
lutfiaomarr
lutfiaomarr

️️️️♿️
Ali-Ahmed-Mohamed
Ali-Ahmed-Mohamed

πŸ’»
Fabrice Innocent
Fabrice Innocent

πŸ“ πŸ’» πŸ‘€
Becky Richardson
Becky Richardson

πŸ“ πŸ› πŸ’» πŸ–‹ 🎨 πŸ“–
Chris Nowicki
Chris Nowicki

πŸ’» πŸ“ πŸ“– βœ…
Frank Alimimian
Frank Alimimian

πŸ“ πŸ’» πŸ“– πŸ”¬
Dan Ott
Dan Ott

πŸ’»
Samgkigotho
Samgkigotho

πŸ“ πŸ› πŸ–‹ πŸ”£ 🎨 πŸ“– πŸ’‘ πŸ€”
Anthony Shellman
Anthony Shellman

πŸ’» πŸ“– πŸ”¬
Alano Teles
Alano Teles

πŸ’¬ πŸ“ πŸ’» πŸ–‹ πŸ”£ πŸ“– πŸ”¬ 🌍
Hannah Lin
Hannah Lin

πŸ’¬ πŸ› πŸ’Ό πŸ’» πŸ€” πŸš‡ 🚧
Ethen Roth
Ethen Roth

πŸ› πŸ’» πŸ“– πŸ€” πŸ‘€
koder_
koder_

πŸ’» πŸ“– πŸ’‘ πŸ€” πŸ”¬
Ikhlas
Ikhlas

πŸ”Š πŸ“ πŸ› πŸ’» 🎨 πŸ€” πŸ‘€ πŸ›‘οΈ πŸ““ πŸ“Ή
Christine Belzie
Christine Belzie

️️️️♿️ πŸ“ πŸ› πŸ’» πŸ–‹ πŸ“– πŸ‘€ βœ… πŸ’‘ πŸ€” πŸš‡ 🚧 πŸ§‘β€πŸ« πŸ”Œ πŸ“† πŸ‘€ πŸ›‘οΈ πŸ”§ 🌍 βœ… πŸ““
Diego Ramos
Diego Ramos

️️️️♿️ πŸ“ πŸ› πŸ’» πŸ–‹ πŸ“– πŸ‘€ βœ… πŸ’‘ πŸ€” πŸš‡ 🚧 πŸ§‘β€πŸ« πŸ”Œ πŸ“† πŸ‘€ πŸ›‘οΈ πŸ”§ 🌍 βœ… πŸ““
thititongumpun
thititongumpun

πŸ› πŸ’» πŸ”£ 🎨 πŸš‡
Jayasurya R D
Jayasurya R D

πŸ’» πŸ”£ πŸ€” 🎨 πŸ‘€
Dmitry
Dmitry

πŸ’»
Wachiou BOURAÏMA
Wachiou BOURAÏMA

πŸ’» πŸ’¬ πŸ’Ό πŸ–‹ πŸ“– πŸ€” πŸ“£ ⚠️ 🌍 βœ… πŸ““
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!

guestbook's People

Contributors

bekahhw avatar muyixone avatar danieltott avatar ant-shell avatar samgkigotho avatar axfez avatar cbid2 avatar macabonilas827 avatar piotrszymaniec avatar tejasq avatar adiati98 avatar kelvinyelyen avatar jmslynn avatar wasscodeur avatar ht-l1 avatar deisenhut avatar chris-nowicki avatar anyanime avatar ananfito avatar alishata128 avatar iqra-issack avatar jayrkyd avatar jayasuryard31 avatar ibnualii avatar muniir1 avatar shelleymcq avatar shirenekboyd avatar darksuei avatar suldana avatar sushij 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.