-
Notifications
You must be signed in to change notification settings - Fork 63
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from acmcsufoss/update/readme
Updated README
- Loading branch information
Showing
1 changed file
with
42 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,87 +1,90 @@ | ||
| # 1st | First Contributions to acmCSUF | ||
|
|
||
| <br> | ||
|
|
||
| `oss.acmcsuf.com/1st` aims to simplify and guide the way beginners make their first contribution. If you are looking to make your first contribution, follow the steps below. If you're not comfortable with command line, [here are tutorials using GUI tools](https://github.com/firstcontributions/first-contributions/blob/main/README.md#tutorials-using-other-tools). If you don't have Git on your machine, [install it](https://docs.github.com/en/get-started/getting-started-with-git/set-up-git). | ||
| <br> <br> | ||
| `oss.acmcsuf.com/1st` aims to simplify and guide the way beginners make their | ||
| first contribution. If you are looking to make your first contribution, follow | ||
| the steps below. If you're not comfortable with command line, | ||
| [here are tutorials using GUI tools](https://github.com/firstcontributions/first-contributions/blob/main/README.md#tutorials-using-other-tools). | ||
| If you don't have Git on your machine, | ||
| [install it](https://docs.github.com/en/get-started/getting-started-with-git/set-up-git). | ||
|
|
||
| ## Welcome to ACM! | ||
|
|
||
| <br> | ||
|
|
||
| ACM at CSUF provides a social online platform, Discord, that brings passionate Titans together to engage in multiple conversations regarding our community, the tech field, and many more. Join [our Discord server](https://acmcsuf.com/discord) to learn more about future events, meet new people, and get involved with the community! | ||
| <br> <br> | ||
| ACM at CSUF provides a social online platform, Discord, that brings passionate | ||
| Titans together to engage in multiple conversations regarding our community, the | ||
| tech field, and many more. Join | ||
| [our Discord server](https://acmcsuf.com/discord) to learn more about future | ||
| events, meet new people, and get involved with the community! | ||
|
|
||
| ## Fork `oss.acmcsuf.com/1st` | ||
|
|
||
| <br> | ||
| <img src="https://github.com/EvanCPSC/1st/assets/142952307/bfd366f9-8f05-4c51-ae3f-2928fbf6c0f0" alt="Forking oss.acmcsuf.com/1st visual example" width="800" /> | ||
|
|
||
|  | ||
| Fork the repository by clicking on the fork button on the top of [`oss.acmcsuf.com/1st`'s page on GitHub](https://github.com/acmcsufoss/1st). This will create a copy of this repository in your account. | ||
| <br> <br> | ||
| Fork the repository by clicking on the fork button on the top of | ||
| [`oss.acmcsuf.com/1st`'s page on GitHub](https://github.com/acmcsufoss/1st). | ||
| This will create a copy of this repository in your account. | ||
|
|
||
| ## Clone the repository | ||
|
|
||
| <br> | ||
| <img src="https://github.com/EvanCPSC/1st/assets/142952307/6725515a-0d2f-4e30-8552-d94fd65e7352" alt="Cloning the github repo visual example" width="800" /> | ||
|
|
||
|  | ||
| Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the _copy to clipboard_ icon. | ||
| Now clone the forked repository to your machine. Go to your GitHub account, open | ||
| the forked repository, click on the code button and then click the _copy to | ||
| clipboard_ icon. | ||
|
|
||
| Open a terminal and run the following git command: git clone "url you just copied" where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url. | ||
|  | ||
| Open a terminal and run the following git command: git clone "url you just | ||
| copied" where "url you just copied" (without the quotation marks) is the url to | ||
| this repository (your fork of this project). See the previous steps to obtain | ||
| the url. | ||
|
|
||
| <img src="https://github.com/EvanCPSC/1st/assets/142952307/fc40d06a-62d5-4ca3-bfcc-e80b3831f7d0" alt="Copy the repo URL visual example" height="400" /> | ||
|
|
||
| For example: | ||
|
|
||
| `git clone https://github.com/this-is-you/acmcsuf.com.git` | ||
|
|
||
| where `this-is-you` is your GitHub username. Here you're copying the contents of the first-contributions repository on GitHub to your computer. | ||
| <br> <br> | ||
| where `this-is-you` is your GitHub username. Here you're copying the contents of | ||
| the first-contributions repository on GitHub to your computer. | ||
|
|
||
| ## Create a branch | ||
|
|
||
| <br> | ||
|
|
||
| Change to the repository directory on your computer (if you are not already there): `cd acmcsuf.com` | ||
| Now create a branch using the git switch command: `git switch -c your-new-branch-name` | ||
| For example: `git switch -c add-ethanthatonekid` | ||
| <br> <br> | ||
| Change to the repository directory on your computer (if you are not already | ||
| there): `cd acmcsuf.com` Now create a branch using the git switch command: | ||
| `git switch -c your-new-branch-name` For example: | ||
| `git switch -c add-ethanthatonekid` | ||
|
|
||
| ## Make necessary changes and commit them | ||
|
|
||
| <br> | ||
|
|
||
| <!-- TODO: Place instructions here. | ||
| Reference: https://acmcsuf.com/1st --> | ||
|
|
||
| <br> <br> | ||
|
|
||
| ## Push changes to GitHub | ||
|
|
||
| <br> | ||
|
|
||
| Push your changes using the command `git push`: | ||
|
|
||
| `git push origin -u add-your-branch-name` | ||
|
|
||
| replacing `<add-your-branch-name>` with the name of the branch you created earlier. | ||
| <br> <br> | ||
| replacing `<add-your-branch-name>` with the name of the branch you created | ||
| earlier. | ||
|
|
||
| ## Submit your changes for review | ||
|
|
||
| <br> | ||
| If you go to your repository on GitHub, you'll see a `Compare & pull request` | ||
| button. Click on that button. | ||
|
|
||
| If you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button. | ||
|  | ||
| <img src="https://github.com/EvanCPSC/1st/assets/142952307/fa97c205-7bde-45d6-94ce-141c98b14832" alt="Compare and pull request visual example" width="800" /> | ||
|
|
||
| Now submit the pull request. | ||
|  | ||
|
|
||
| Soon, someone will be merging all your changes into the master branch of this project. You will get a notification email once the changes have been merged. | ||
| <img src="https://github.com/EvanCPSC/1st/assets/142952307/7a6cde83-7287-4cdb-9adb-995675969f5f" alt="Creating the pull request visual example" width="800" /> | ||
|
|
||
| Soon, someone will be merging all your changes into the master branch of this | ||
| project. You will get a notification email once the changes have been merged. | ||
|
|
||
| --- | ||
|
|
||
| ### CONGRATULATIONS ON MAKING YOUR FIRST CONTRIUBUTION | ||
|
|
||
| Inspired by [First Contributions](https://github.com/firstcontributions/first-contributions#readme) | ||
| Inspired by | ||
| [First Contributions](https://github.com/firstcontributions/first-contributions#readme) | ||
|
|
||
| Maintained with 💚 by [**@acmcsufoss**](https://github.com/acmcsufoss) |