/D_D-directory

Primary LanguageJavaScript

Developer Dao Minimum Viable Contribution

Table of contents

What is this ?

This repository serves as a Miminum Viable Contribution for every member of Developer DAO, where people from all levels of proficiency can contribute in a small but meaningful way and add their presence to the public list of Developer DAO members.

How to contribute ?

Not Familiar with Git and Github

If you are familiar with how Git & Github works , or would like to test another way of doing things , click here

  1. First you will need a Github account
    • Click here for a small explanation of what is Git and Github ?
  2. On the project page , at the top right there will be a button to Fork the project
    • Click here for a small explanation of what is Forking ?
  3. In your version of the project (that should be under https://github.com/YOUR-USERNAME/D_D-directory) navigate to the public Directory -> Contributors Directory
  4. Add new file with this format : name.json
  5. paste inside of it this code :
{
    "name":"Your-Name",
    "discord":"Your-Discord-Name",
    "NFT":"Your-NFT-Number"
 }
  1. replace the placeholder information with your relevant information
  2. Scroll down and click on commit new file
    • Click here for a small explanation of what is a commit ?
  3. Pat yourself on the back 🎉 , you just made your first open source commit.
  4. Go back to your version of the projects main page
  5. Click on contribute -> Open Pull Request
  • Click here for a small explanation of what is a pull Request ?
  1. Check that the only file changes you have done are adding the new file that contains your relevant informations
  2. Create Pull Request
  3. 🥳 Celebrate 🥳 ! you have just made your first Pull Request to an open source project!
  4. Your changes will soon be accepted by one of the D_D members and you will see your name shine in the Website

Familiar with Git and Github

If you are not familiar with how Git & Github works, or can't access or edit your code on your machine , you can do all of these steps from within the github browser by following the steps here

  1. First you will need a Github account
    • Click here for a small explanation of what is Git and Github ?
  2. On the project page , at the top right there will be a button to Fork the project.
    • Click here for a small explanation of what is Forking ?
  3. At this point you will need to have Git installed in your machine. Click here for more info on how to do that.
  4. Go to your version of the project (that should be under https://github.com/YOUR-USERNAME/D_D-directory) and click on the Code button, copy the link that it displays.
  5. Open your terminal and type git clone <URL you copied from the last step>. This will create a new directory with the same name as the Repository.
  6. Open that directory in your favorite IDE or text Editor -> navigate to public/contributors
  7. Add new file with this format : name.json
  8. paste inside of it this code :
{
    "name":"Your-Name",
    "discord":"Your-Discord-Name",
    "NFT":"Your-NFT-Number"
 }
  1. Replace the placeholder information with your relevant information
  2. Go back to your terminal and add the file you just create to the changes to be commited
    • git status will display the modified files (normally there should only be one file)
    • git add . (The dot is part of the commant) will add your file to the changes to be commited
    • git commit -m "create <YOUR NAME>.json will commit your changes locally with the message create <YOUR NAME>.json
    • git push will push your changes to your remote repository in github
  3. Congratulations 🎉 , you just made your first open source commit.
  4. Go back to your version of the projects main page
  5. click on contribute -> Open Pull Request
  • Click here for a small explanation of what is a pull Request ?
  1. check that the only file changes you have done are adding the new file that contains your relevant informations
  2. Create Pull Request
  3. 🥳 Celebrate 🥳 ! you have just made your first Pull Request to an open source project!
  4. Your changes will soon be accepted by one of the D_D members and you will see your name shine in the Website

Definitions

What is Git and Github

Click to expand!

What is Git?

Git is a free and openSource tool that tracks all changes made to your project files and keeps a history of them. It also makes working with people easier by intelligently combining all the changes into one (unless there's conflicts)

Github

Github is a website where you can host your projects code inside repositories. It leverages the Git tool by adding more features to it readily available from the website

What is a commit

Click to expand!

Commit

A Commit is an operation by which you save all the changes you've made to your code in your projects repository , which is where Git stores all the history of your files.

What is forking

Click to expand!

Forking

Forking is the act of making a copy of the whole repository inside your own account. Forking is an action specific to public repository hosting websites such as Github/Gitlab/etc...

What is a pull request

Click to expand!

Pull Request

A Pull Request is an action that lets you tell the repository's owner or maintainer that you have changes that you would like to be added to the latter. It is specific to public repository hosting websites such as Github/Gitlab/etc... It also creates a space where changes and code can be discussed.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode. Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes. You may also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode. See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.

It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes.

TODO list

  • add a small explanation below the divider to explain what is it
  • needs a footer
  • things need to look a lil bit better visually
  • next steps after finishing this task (add your own touch , change the front end stuff etc..)