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.
If you don't have Git on your machine,
install it.
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 to learn more about future events, meet new people, and get involved with the community!
Fork the repository by clicking on the fork button on the top of
oss.acmcsuf.com/1st's page on GitHub.
This will create a copy of this repository in your account.
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.
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.
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
Create a new Markdown file inside /collaborators that looks like gh-user.md,
where gh-user is your GitHub username. Then, inside that file, include one
line in the following format:
[**@<your-gh-username>**](https://github.com/<your-gh-username>) [Description]
Replace where it says <your-gh-username> with your GitHub username, so that the
hyperlink directs to your GitHub profile. Then, add a short description of yourself!
At the end, it will be rendered in the HTML page with the following format:
Please refer to any of the example Markdown files from the list of /contributors!
Add those changes to the branch you created using the git add command:
git add <your-gh-username>.md
And commit them with a short description, using the git commit command:
git commit -m "Added <your-gh-username>.md"
replacing <your-gh-username> with your GitHub username :)
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.
If you go to your repository on GitHub, you'll see a Compare & pull request
button. Click on that button.
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.
Inspired by First Contributions
Maintained with 💚 by @acmcsufoss