Your First Pull Request
Here's a quick tutorial on creating your first pull request.
-
Fork the project, clone your fork, and configure the remotes:
# Clone your fork of the repo into the current directory git clone https://github.com/<your-username>/dbatools.git # Navigate to the newly cloned directory cd dbatools # Assign the original repo to a remote called "upstream" git remote add upstream https://github.com/dataplat/dbatools.git
-
If you cloned a while ago, get the latest changes from upstream:
git checkout development git pull upstream development
-
Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:
git checkout -b <topic-branch-name>
-
Commit your changes in logical chunks. For any Git project, some good rules for commit messages are
- the first line is commit summary, 50 characters or less,
- followed by an empty line
- followed by an explanation of the commit, wrapped to 72 characters.
See a note about git commit messages for more.
The first line of a commit message becomes the title of a pull request on GitHub, like the subject line of an email. Including the key info in the first line will help us respond faster to your pull.
-
Push your topic branch up to your fork:
git push origin <topic-branch-name>
-
Open a Pull Request with a clear title and description.
-
Done!
Tutorial used from: pointcloudlibrary