first contributions ja.github.io

Start your OSS activities with a complete Japanese tutorial

This is an open source Japanese project designed to make it easy for beginners to participate.
Follow the tutorial to experience your first contribution!

We are happy to help you with your first pull request ✌️

Introduction

This project is a Japanese tutorial to help you learn how to use Git/GitHub in practice and how to collaborate in open source!

Who is this for?

• Beginners who want to learn practical ways to use Git/GitHub
• People who are interested in open source but don't know how to contribute
• Or, you want to improve your skills while enjoying collaboration through more contributions

What is the purpose of this project?

• Experience actual joint development using GitHub, which is difficult to learn on your own.
• Everyone has confidence and learn how to contribute to open source projects
• And helping developers who like open source culture connect

What is open source in the first place?

What is open source?

When a project is open source, it means that anyone can use it at their own whim, learn, modify it, and distribute your project for any purpose.

In most cases, open source projects are free to participate in development!

Contributions to open source projects are
It's a great way to improve your skills through collaboration with other developers.

If you're uninterested in open source and wondering if you need to put effort into it,
See here: Why contribute to open source?

How to participate

Let's experience the contributions to open source projects right away!

What should I do?

As a participant in this project, we will add the following information to our Contributors.json file!

 "name": "あなたのハンドルネーム",
"github": "あなたのGitHubアカウントのURL",
"favoriteColor": "あなたの好きなカラーコード",
"favoriteEmoji": "あなたの好きな絵文字"

The information entered will be displayed on the website as an emoji icon.
So, every time the number of contributors increases, the site becomes lively!

emoji-animation.mp4

We want to make First Contributions JA's website even more pop than it is now!
Please try and move your hands

• Actual move your hands
  • set up:
  • Step 1: Fork this repository
  • Step 2: Clone to local machine
  • Step 3: Create a work branch
  • Step 4: Make changes
  • Step 5: Commit your changes
  • Step 6: Push the changes
  • Step 7: Create a pull request (PR)
  • Step 8: Respond to reviews and feedback
  • Finish: ?
• More steps
• Other contributions

Actual move your hands

Become an open source contributor in 8 simple steps ?

• If you need help, ask at Discussions!
• If you find any improvements to this project, please let us know through Issues!

No matter how small, we are welcome?

---

set up:

• If you don't have a GitHub account, please create one via Sign up.
  • And if necessary, we recommend that you do a GitHub Hello World tutorial for complete beginners first.
• If an access token that replaces a password is not set, an error may occur at the time of a clone.
  • In that case, see Configuring GitHub Access Tokens.

---

Step 1: Fork this repository

• Fork this repository by clicking the "Fork" button in the top right corner of the project page (this page) on GitHub.

• Then click on the "Create fork" button.
  • All items such as "Repository name", "Description", and "Copy the main branch only" are OK as they are in the original format!

Tip

This will create a copy of this repository in your GitHub account?

---

Step 2: Clone to local machine

You can also edit the file on GitHub,
Copy the forked repository to your local machine for a more general workflow experience.

• On GitHub, go to the forked repository page, click the green "Code" button and copy the HTTPS URL.
  • Your URL should look like this: https://github.com/<あなたのアカウント名>/first-contributions-ja.github.io.git

• Open a terminal and navigate to the directory where you want to clone the repository.
  • For example, if you want to specify the clone destination on the desktop, you can use the following command:

   cd desktop
  

• Use the following command to clone the forked repository to your local machine:

   git clone 先ほどコピーしたクローンURL
  

Tip

This allows the repository to be copied to your local machine and working in the local environment

---

Step 3: Create a work branch

• Navigate to the repository directory with the following command:

   cd first-contributions-ja.github.io
  

• Install the packages needed for this project with the following command:

   npm install
  

  
  
  Note: What is npm install?❓❓

  
  

  With Node.js installed, run the npm install command to install the libraries required for this project in bulk.

  What you can do after installing npm install

  • Start the local server and check the view in the browser
    • After executing npm run dev command, click on the URL that appears to confirm
  • Automatic code checking and shaping when committing
    • It is run using a library called husky
    • It runs automatically, so there is no need to execute any commands or do any work

  
  

  For more information about the npm install command, please see here!

  ?Note) If Node.js is not installed on your local machine, npm install command will cause an error.

  In that case, there are two ways to deal with it .

  • Skip the npm install procedure.
    • Without this procedure, you can have a minimum contribution experience, so if it is difficult, you can skip it.
    • I would like to know for reference how many people will stumble here, so it would be very helpful if you could report in your pull request such as " npm install didn't work."
  • Install Node.js.
    • For installation instructions, please refer to the following website:
    • Node.js official website / How to install Node.js (macOS) Progate / How to install Node.js (Windows) Progate
    • If you want to know more about Node.js, what is Node.js? Why are everyone using it? Please refer to Qiita.
    • If you are interested in web/JavaScript development, I recommend using this opportunity to install it?

• Next, create a new branch to separate your work from main branch of your project.
  • You can use the following command: git switch -c <ブランチ名>
  • Branch names are meaningful names that are related to the work you are about to do. So it looks like this:

   git switch -c add-yourname
  

  • ?Note )
  • Don't forget to replace yourname with your handle
  • Please enter the branch name in half-width alphanumeric characters without hiragana, kanji or white spaces.
    • : Ogino Chihiro, Ogino Chihiro
  • example:

   git switch -c add-oginochihiro

  

Tip

This makes you ready to make changes without directly affecting the main project repository?

---

Step 4: Make changes

• To get started, open the cloned folder in your favorite code editor, such as VSCode.
  • Before making any changes, make sure you work with the branch you created in the previous step!
  • You can check the current branch with the following command:

   git status
  

• Now let's make changes to the Contributors.json file.
  • Copy and paste the following code into the "end of list" in your Contributors.json file:

   ,
  {
    "name": "あなたのハンドルネーム",
    "github": "あなたのGitHubアカウントのURL",
    "favoriteColor": "あなたの好きなカラーコード",
    "favoriteEmoji": "あなたの好きな絵文字"
  }
  

• Then replace the contents of the pasted text with your own content.
  • ? Please refer to the following website: List of emojis, Primary Color Dictionary, Japanese Traditional Colors
  • For example, if you replace it all, it would look like this:

   <!-- 変更後 -->
    ~~
    },
    {
      "name": "oginochihiro",
      "github": "https://github.com/first-contributions-ja",
      "favoriteColor": "#ffffff",
      "favoriteEmoji": "?"
    }
  ]
  

---

Step 5: Commit Changes

• Go back to the terminal and use the following command to commit the changes to the local repository:
  • Don't forget to replace yourname with your handle name.

   git add .
  git commit -m "yournameをコントリビューターに追加"
  

Tip

This will log any changes you make to your Contributors.json file

---

Step 6: Push the changes

• Push changes to the forked remote repository:

   git push origin HEAD
  

Tip

This will allow the commits you mentioned earlier (local changes) to your remote repository on GitHub?

---

Step 7: Create a pull request (PR)

• Go to the forked remote repository page on GitHub ( https://github.com/あなたのアカウント/first-contributions-ja.github.io ).
• Click the "Compare & pull request" button at the top.

• Then, after confirming the following, click the "Create pull request" button.
  • Just to be safe, make sure you are heading from the add-yourname branch of your repository to main branch of first-contributions-js!
  • The title remains as initial input, and the description is blank!

Tip

This will request that any changes you have made by forking be reflected in the repository from which you fork?

---

Step 8: Responding to reviews and feedback

Your PR will be reviewed (confirmed) by the project maintainer.

• It's pretty normal for reviewers to ask for changes to the PR. If that happens, make a correction as it is a common occurrence.
  • In that case, you simply go back to the same working branch as before and make the requested modifications, just commit and push the changes in the same way.
  • PR will be automatically updated with a new push.

Most reviews will be made within 24 hours, but there may be delays of several days. Please wait patiently ☕

---

Finish:?

• Once the pull request is approved, any changes you make will be merged into the main project.

thank you for your hard work!
And thank you for your time and effort to contribute to First Contributions JA! !

More steps

Important

If you find this project useful, press the star button from the top of the page!
Also, share with your followers and acquaintances to spread this project!

You've learned how to contribute to open source projects!

• Look back at the work you have done and keep your knowledge in place.
  • You just completed the standard workflow that you often experience as a contributor: Read the documentation → Fork → Make changes → Pull request !
• First Contributions JA is an open source project, so you can contribute in a different way than the tutorial above.
  • Please let us know what you think about this project on Discussions?
  • If you are interested, check out other contributions.
• Please also contribute to other open source projects!
  • Check out the beginner topics on GitHub (first-contributions and good-first-issue)!
  • If you have a repository you want to contribute to, look for issues labeled " good first issue ."
  • This generally represents an issue for beginners who are new to specific projects or open source itself!

Other contributions

If you want to make more contributions, please refer to the Contribution Guidelines!
Any small contributions such as adding code, fixing bugs, improving documentation are welcome?

license

This project is licensed under MIT LICENSE.

Acknowledgments

This project includes first-contributions and Contribute-To-This-Project.
It is influenced by a great open source project designed for beginners.