title | tags | ||||
---|---|---|---|---|---|
How to Make an Open Source Contribution, a step-by-step Walkthrough |
|
Example: Making an open source contribution to drizzle-team/drizzle-orm-docs
- Fork the repository you want to contribute to
- Clone the fork to your local machine
- Create a new topic branch to work on
- Make your changes to the project
- Inspect, stage, and commit the changes if all is good
- Push your branch/changes to your remote fork
- Open a pull request from your fork/branch to the original repository
# gh repo fork <org>/<repo>
$ gh repo fork drizzle-team/drizzle-orm-docs
# gh repo fork <org>/<repo>
$ gh repo fork drizzle-team/drizzle-orm-docs
# gh repo clone <your-username>/<repo>
$ gh repo clone devinschumacher/drizzle-orm-docs
$ cd drizzle-orm-docs
# git checkout -b <branch-name>
$ git checkout -b fix-typo
$ code .
- `drizzle-kit generate` lets you generate migrations based on you Drizzle schema.
+ `drizzle-kit generate` lets you generate migrations based on your Drizzle schema.
$ git status
# output
On branch fix-typo
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git restore <file>..." to discard changes in working directory)
modified: src/content/documentation/kit-docs/commands.mdx
$ git add src/content/documentation/kit-docs/commands.mdx
$ git commit -m "fix: typo in commands.mdx"
# git push -u origin <branch-name> OR git push --setup-upstream origin <branch-name>
$ git push -u origin fix-typo
# gh pr create --base main --head <your-username>:<branch-name> --title "Your PR title" --body "Your PR description"
gh pr create --base drizzle-team:main --head devinshcumacher:fix-typo --title "Fix typo in commands.mdx" --body "This PR fixes a typo in the commands documentation."
Or, if you want to use the web interface:
- Go to your github fork of the repository > Pull Requests > New Pull Request
- Select your branch from the dropdown > Create Pull Request