Hello coders! this year, we are proud to open-source our hackathon project. We welcome everyone to join our quest and contribute in this next-gen web3 project. Join our Discord server for all the latest updates regarding the contributions.
Hacktoberfest is for everyone. It is a month-long celebration from October 1st - 31st sponsored by Digital Ocean and GitHub to get people involved in Open Source. Create your very first pull request to any public repository on GitHub and contribute to the open source developer community.
https://hacktoberfest.digitalocean.com/
https://hacktoberfest.digitalocean.com/
If you liked working on this repo, please share this repo as much as you can and star this repo to help as many people in open-source as you can.
You can get your own fork/copy of this project Storz by using the Fork button or clicking this.
Once you have completed these steps, you are ready to start contributing by checking our issues tab and creating pull requests.
For no-code/low-code contributions, we would soon update you all in our Discord server.
To make your own local copy of the repository you would like to contribute to, let’s first open up a terminal window.
We’ll use the git clone command along with the URL that points to your fork of the repository.
This URL will be similar to the URL above, except now it will end with .git . The URL will look like this:
https://github.com/anomic30/Storz.git
You can alternatively copy the URL by using the green "Clone or download" button from your repository page that you just forked from the original repository page. Once you click the button, you’ll be able to copy the URL by clicking the binder button next to the URL:
Once we have the URL, we’re ready to clone the repository. To do this, we’ll combine the git clone command with the repository URL from the command line in a terminal window:
git clone https://github.com/anomic30/Storz.git
To create your branch, from your terminal window, change your directory so that you are working in the directory of the repository. Be sure to use the actual name of the repository (i.e. Storz) to change into that directory.
cd Storz
Now, we'll create our new branch with the git branch command. Make sure you name it descriptively so that others working on the project understand what you are working on.
git branch my-branch
Now that our new branch is created, we can switch to make sure that we are working on that branch by using the git checkout command:
git checkout my-branch
Once you enter the git checkout command, you will receive the following output:
Output:
Switched to branch 'my-branch'
At this point, you can now modify existing files or add new files to the project on your own branch.
Once you have modified existing files or added new files to the project:
Before you stage or before you perform your final commit, your need to lint and format your changes.
The following steps assumes you have installed this projects dependence for the first time. If not run npm install.
To format and/or lint your changes use any of the following:
# This command is preferred as it lint and format your changes
npm run lint:format
# To lint only, fix fixable problems
npm run lint
# To format only
npm run format
# To lint a single file named "index.js" on the root directory
npx eslint ./index.js
# To format a single file named 'user.js' and on directory path say routes/
npx prettier ./routes/user.jsNote that some changes may not be fix automatically, as a result you are required to fix the problem manually. On vscode, you can fix problem(s) automatically by:
- Hovering on it and click on
Quick fixOR - Click on the line that has the problem or warning then
CTRL + .In both cases use one the available options likefix all auto-fixable problemsorfix this prettier/prettierto fix the error(s)
Most of the linting rules ( or code quality) follows eslint rule and the Airbnb JavaScript Style Guide. Read the guide
Read eslint and prettier docs, and also learn how to install and integrate them with your text editor (or IDE).
To use with vscode, install prettier extension and eslint extension
Always lint:format, and manually fix lint, or code format problems before staging ... pushing your commits
Given that you have linted and formatted your changes, you can add now add the changes to your local repository, which you can do with the git add command. Let’s add the -A flag to add all changes that we have made:
git add -A
or
git add .
Next, we’ll want to record the changes that we made to the repository with the git commit command.
The commit message is an important aspect of your code contribution; it helps the other contributors fully understand the change you have made, why you made it, and how significant it is. Additionally, commit messages provide a historical record of the changes for the project at large, helping future contributors along the way.
If you have a very short message, you can record that with the -m flag and the message in quotes:
Example:
git commit -m "Updated Readme.md"
At this point you can use the git push command to push the changes to the current branch of your forked repository:
Example:
git push --set-upstream origin new-branch
While you are working on a project alongside other contributors, it is important for you to keep your local repository up-to-date with the project as you don't want to make a pull request for code that will cause conflicts. To keep your local copy of the code base updated, you'll need to sync changes.
We'll first go over configuring a remote for the fork, then syncing the fork.
Next, you'll have to specify a new remote upstream repository for us to sync with the fork. This will be the original repository that you forked from. You'll have to do this with the git remote add command.
git remote add upstream https://github.com/anomic30/Storz.git
In this example, upstream is the shortname we have supplied for the remote repository since in terms of Git, "upstream" refers to the repository that you cloned from. If you want to add a remote pointer to the repository of a collaborator, you may want to provide that collaborator’s username or a shortened nickname for the shortname.
Once you have configured a remote that references the upstream and original repository on GitHub, you are ready to sync your fork of the repository to keep it up-to-date.
To sync your fork, from the directory of your local repository in a terminal window, you’ll have to use the git fetch command to fetch the branches along with their respective commits from the upstream repository. Since you used the shortname "upstream" to refer to the upstream repository, you’ll have to pass that to the command:
git fetch upstream
Switch to the local main branch of your repository:
git checkout main
You'll now have to merge any changes that were made in the original repository's main branch, that you will access through your local upstream/main branch, with your local main branch:
git merge upstream/main
At this point, you are ready to make a pull request to the original repository ✨.
You should navigate to your forked repository, and press the “New pull request” button on your left-hand side of the page.
Don't forget to join our Discord server as we will be posting important updates regarding the contributions. Have fun and make new friends in the server and happy coding to everyone!