Skip to content

Latest commit

 

History

History
227 lines (138 loc) · 8.68 KB

CONTRIBUTING.md

File metadata and controls

227 lines (138 loc) · 8.68 KB
Raw

Contributing Guide

📢 Only PRs from existing Virtual Coffee members will be accepted.

Welcome to the contributing guide for Virtual Coffee's Preptember repo! Thank you so much for considering contributing to this repository 💙.

We take our Code of Conduct very seriously, and all contributors must abide by it. Let’s treat each other with respect, and remember, we are all people who care and are trying. If you believe someone has violated the Code of Conduct, please fill out our CoC Violation Form, which you can do anonymously.

New Contributors

If you're new to open source, check out the resources below to help you familiarize yourself with Git, GitHub, and the contribution flow:

Contribution Type

You can make two types of contributions to this repo:

1. 🌱 Practicing Open Source

Add your name, link to your GitHub profile, and your favorite thing to the preptember-participants.md file.

Note

For 2024, the favorite thing is cake or snack.

2. 📃 Repositories List

Add the name and link to a repository you recommend for Hacktoberfest to the repositories-list.md file. Do this only after the repository meets our requirements — see our repository checklist.

You can add multiple repositories here and you can always make another pull request if you have more for us later in the month!

Getting Started

We recommend you work on the changes in your local environment because most of the contribution process requires you to do so rather than directly on GitHub.

1. Create an issue

  1. Click the Issues tab at the top.
  2. Click the green New issue button.
  3. Click the Get started button next to the ➕ Add participants to add yourself as a Preptember participant or 📃 Add repositories to add repositories to the list.
  4. Edit the title and complete the issue form.
  5. Click the green Submit new issue button at the bottom.

Additional Resources

2. Fork this repository

Click the fork button at the top of the front page.

Forking is a process to create a copy of this repository in your GitHub account. You always want to remember to fork a repository before cloning it.

3. Clone the repository

Clone a repository means copying the remote repository into your local machine.

On GitHub

  1. Click your profile picture on the right top.
  2. Click "Your repositories".
  3. Open the forked repo by clicking on it.
  4. Click the green <> Code button.
  5. Click the copy icon to copy the HTTPS URL.

On your local machine

  1. In your terminal, run this command to create a copy of the forked repository in your local machine:

    git clone https_url

    Change the https_url with the HTTPS link that you've copied.

  2. Navigate to the directory where your local repository lives.

    cd vc-preptember

Remember that you always want to work on and push your changes into the forked repository, not the original one.

4. Create a branch

A branch is an isolated environment to work on and save your changes. Later on, you will push this branch to the remote repository after you finish working on your changes.

Run the following command to create a branch:

git checkout -b YOUR-BRANCH-NAME

You can name the branch anything you want — for example, alice-add-profile.

5. Work on changes

🌱 Practicing Open Source

  1. Open the preptember-participants.md file in VSCode or another text editor you use.

  2. Add yourself to the file in this format:

    - [Your name](link to your GitHub profile) | your favorite thing

    For example:

    - [User Name](https://github.com/username) | Favorite thing

📃 Repositories List

  1. Open the repositories-list.md file in VSCode or another text editor you use.

  2. Add the repository(ies) that you recommend for Hacktoberfest. Please make sure the repositories pass the repository checklist before you add them.

    - [Organization / Repository Name](link to the repository)

    For example:

    - [Virtual Coffee / virtualcoffee.io](https://github.com/Virtual-Coffee/virtualcoffee.io)

6. Add your changes

After you finish working on your changes, you must add them first. Adding changes means moving them into the staging area, where they will be ready to be saved (committed).

Run this command in your terminal:

git add .

This command will add all files with changes to the staging area.

7. Commit your changes

Now, it's time to commit the changes. Committing changes means saving your changes.

Run the following command:

git commit -m "Your message"

Change Your message into your own message. For example:

git commit -m "Add Alice to Preptember participants"

💡 Good to know:

When you make changes in an existing file, you can add and commit them all together with this command:

git commit -am "Your message"

8. Push your changes

You want to push your changes to your remote (forked) repository. Run this command in your terminal:

git push -u origin YOUR-BRANCH-NAME

Change YOUR-BRANCH-NAME with the name of your working branch. For example:

git push -u origin alice-add-profile

9. Create a pull request (PR)

  1. Go to your forked repository on GitHub.

    To ensure you're on the forked repo, look at the repo name on the top left beside the GitHub logo. It should have your GitHub username in the beginning: your-username / repository-name.

  2. Click the Compare & pull request green button on the top.

  3. Fill in the pull request form.

  4. Click the green Create pull request button on the bottom.

And that's it! Congratulations on your first contribution to this repo! 🎉

Resolve Merge Conflicts

You might encounter merge conflicts. When you encounter merge conflicts, you need to resolve them before your pull request can be merged into the main branch to avoid collision.

Merge conflicts usually occur when changes are on the same line(s), in the same file(s), from 2 different branches. It is common to encounter merge conflicts when contributing to open source.

Resources

Walkthrough Video

Resolve.Conflict.VC-Preptember.Repo.-.720p.mp4

Tip

  • You can always ask for help in the #open-source or #help-and-pairing channel in Slack. We're here to help you! 💙
  • We recommend resolving the merge conflicts in your local environment rather than directly on GitHub.
  • For this contribution, we recommend you accept both changes.

Awaiting Review

Once you've submitted your pull request, the only thing left is to wait for feedback from one of the project maintainers. Since this is volunteer work for all, if it's been over one week and you have not received any acknowledgment, you can post a comment on your pull request reminding you of its status.

Suggested Changes

We may ask for changes before a pull request can be merged using suggested changes or pull request comments.

As you update your pull request and apply changes, mark each conversation as resolved.