First Contributions
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.
Last updated September 9th, 2022
Welcome to ACM!
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 acmcsuf.com
Fork the repository by clicking on the fork button on the top of acmcsuf.com
's page on GitHub. This will create a copy of this repository in your account.
Clone the repository
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.
Create a branch
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
Want to make it rain?
Step 1: Add your SVG or PNG in /static/assets/your-new-thing.(svg|png)
(See:
Basic shapes).
Step 2: In a text editor, make some changes by adding some code to show off the new thing you added.
/src/lib/1st/confetti/your-new-thing.ts
, and save it.
For example:
export default 'url(/assets/your-new-thing.(svg|png))';
If you go to the project directory and execute the command git status
, you'll see
there are changes.
Add those changes to the branch you just created using the git add
command:
git add -A && git commit -m "Your Message"
Push changes to GitHub
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.
Submit your changes for review
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.
CONGRATULATIONS ON MAKING YOUR FIRST CONTRIUBUTION
Inspired by First Contributions