You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To work on an open-source project, you will first need to make your copy of the repository. To do this, you should fork the repository and then clone it so that you have a local working copy.
Get your own Fork/Copy of repository by clicking Fork button right upper corner.
Step 2: Clone the Forked Repository
After the repository is forked, you can now clone it so that you have a local working copy of the codebase.
To make your local copy of the repository follow the steps:
This is one of the very important step that you should follow to contribute to Open Source. A branch helps to manage the workflow, isolate your code and does not create a mess. To create a new branch:
Keep your cloned repo up-to date by pulling from upstream (this will also avoid any merge conflicts while committing new changes)
git pull origin main
Step 5: Contribute
Make relevant changes according to the issue that you were assigned on. Contribute in any way you feel like :)
Step 6: Committing and Pushing
Once you have modified an existing file or added a new file to the project, you can add it to your local repository, which we can do with the git add command.
git add .
With our file staged, 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.
git commit -m "useful commit message"
At this point you can use the git push command to push the changes to the current branch of your forked repository:
git push origin <branch-name>
Step 7: Create Pull Request
Now, you are ready to make a pull request to the original repository.
You should navigate to your forked repository, and press the "Compare & pull request" button on the page.
GitHub will alert you that you can merge the two branches because there is no competing code. You should add in a title, a comment, and then press the “Create pull request” button.
CONTRIBUTING A NEW TEMPLATE?
Please adhere to these guidelines
Create a folder with the name of your frontend template
Start building inside your folder with an entry file called index.html and after building, attach an image named "preview.png" within the folder root which represents the preview image of your template
Go into the style_link.json file and add an object corresponding to your project in the following format:
If the folder name has white spaces e.g "My Project", the object should be:
{
"name": "My Project", (not "my project" or "My project" or "My-project")
"link": "My%20Project/index.html" (not "My Project/index.html" or "My project/index.html"
},
Note: The name key is case sensitive and the link key is white space sensitive in the json object so if you have white spaces in the initial name of your folder, replace space with "%20" in the json link but if there are no white spaces like in the case of "ABlogPage" or "Form", use the exact name of the project
If the folder name has no white spaces e.g "My-project", the object should be:
{
"name": "My-project", (not "my-project" or "My-Project" or "My Project")
"link": "My-project/index.html" (not "My%20project/index.html" or "My-Project/index.html")
},