Thank you for considering contributing to Learn-Git! This repository is intended to be a resource for people who are learning Git, and your contributions can help make it even better.
If you would like to contribute to this repository by making the tutorial better or by potentially translating it into another language, please create a new issue with that idea or improvment, and if the idea is good enough I or potentially members of this repository will approve it. At that point you could create the change and then create a pull request.
Before getting started, please read and adhere to the code of conduct. We want to maintain a respectful and welcoming community for all participants.
Here are the basic steps to contribute to Learn-Git:
- Fork the repository
- Create a new branch for your changes
git branch "branch-name"
Then switch on that branch use following syntax :
git checkout "branch-name"
- Make your changes and commit them to your branch
Use this command in terminal after making any change or addition
git add .
Syntax for Commit that change or addition
git commit -m "A brief description of the changes made"
- Push your changes to your fork Push the changes to GitHub: After committing the changes to your local repository, you'll need to push them to GitHub. This will update the copy of the repository in your GitHub account with the changes you made. To push the changes, use the following command:
git push origin branch-name
- Create a pull request
After pushing the changes to GitHub, when you reload the forked repository, you will see the option to create a pull request. Click on that button to create a pull request.
This will take you to a page where you can review the changes you made and provide a description of your pull request.
Make sure to include a clear and concise description of the changes you made and why you made them.
If there are any issues or concerns that the repository owner should be aware of, make sure to mention them in the pull request description.
Once you're satisfied with the description, click on the "Create pull request" button.
Wait for feedback: After creating the pull request, the repository owner will review your changes and provide feedback.
We welcome contributions in the following forms:
If you find any mistakes or inaccuracies in the existing content, please open an issue, please describe the mistakes or inaccuracies in detail. If the accuracy of these mistakes or inaccuracies are verified then you may open a pull request with these changes. Please try and be dilligent and link the issue to your pull request. Please also keep in mind that personal preferance in grammar doesn't necessarily constitute a necessary change.
If you have an idea for new content that you think would be valuable for people learning Git, please open an issue to discuss it first. Once it's been approved, feel free to create a pull request with your new content.
If you have suggestions for improving existing content, please open an issue to discuss it first. Once it's been approved, feel free to create a pull request with your improvements.
When contributing to Learn-Git, please adhere to the following style guide:
- Use clear and concise language
- Use headings and subheadings to break up sections
- Use examples and visuals to illustrate concepts
- Include links to relevant resources when appropriate
- Use the appropriate spelling and grammar used throughout for your given translation.
The most important role in this repository is that of a collaborator on this project. To be considered for the role of collaborator you must first prove your willingness to work on this project to maintain it and keep it up to date. While we are always looking for future collaborators please keep in mind that your role could be terminated from this repository if you choose to no longer participate in maintaining it. Failure to add to this repository in any meaningful way can result in your collaborator role being terminated without warning.
Thank you for taking the time to contribute to Learn-Git! Your contributions can help make Git more accessible to people who are just getting started.