Hacktoberfest 2022 - EXCLUDED PROJECT DO NOT CONTRIBUTE
Hacktoberfest is a month-long global celebration of open source software run by DigitalOcean in partnership with Docker and AppWrite, with a strong focus on encouraging contributions to open source projects.
- Hacktoberfest is open to everyone.
- Four quality pull requests must be submitted to public GitHub and/or GitLab repositories.
- You can sign up anytime between October 1 and October 31.
How to contribute to this project:
1. Star and Fork this Repository
Star and fork this repository on GitHub by navigating at the top of this repository.
GitHub repository URLs will reference both the username associated with the owner of the repository, as well as the repository name. For example, {acmbvp} is the owner of the Hacktoberfest repository, so the GitHub URL for this project is: https://github.com/0x01-itsmurphy/flutter_portfolio_hacktoberfest
When you’re on the main page of a repository, you’ll see a button to "Star" and “Fork” the repository on the upper right-hand side of the page, underneath your user icon.
2. Clone the Repository
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.
In the cloud_haiku example above, the URL will look like this: https://github.com/your-username/flutter_portfolio_hacktoberfest.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/your-username/flutter_portfolio_hacktoberfest.git
3. Create a New Branch
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. flutter_portfolio_hacktoberfest) to switch into that directory.
cd flutter_portfolio_hacktoberfest
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 new-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 new-branch
Once you enter the git checkout
command, you will receive the following output:
Output:
Switched to branch 'new-branch'
At this point, you can now modify existing files or add new files to the project on your own branch.
Make Changes Locally
Open repository in VS Code or Android Studio (I'm using VS Code)
Open Terminal and Enter Command
flutter pub get
Run the project
flutter run
Go-To Folder
'lib > YourDetails'
and Open'contributers_github_username.dart'
file
Save the file and open
'contributors_name.dart'
file
Once you have modified existing files to the project, you can add them 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 "added myself"
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 origin new-branch
5. Create Pull Request
At this point, you are ready to make a pull request to the original repository.
Navigate to your forked repository, and press the “New pull request” button on your left-hand side of your Repo page.
Hurray!!!
Thanks for contributing