Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Are you considering sending a Pull Request? You may make my day. But please read and follow these rules before you proceed.
Guidelines for Pull Requests
- Please ask first Before embarking on any significant pull request (e.g. implementing features, refactoring code... ), otherwise you risk spending a lot of time working on something that will not get merged into the project :-(
By submitting a patch, you agree that your code will be licensed under the same hippie license that YOURLS uses, aka the "Do whatever the hell you want with it" license.
See also MIT License terms.
Please adhere to YOURLS Coding Standards. Make sure you've tested your patch under different scenarios (various browsers, non default installation path, etc...)
Pull Request crash course
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>/YOURLS # Navigate to the newly cloned directory cd YOURLS # Assign the original repo to a remote called "upstream" git remote add upstream https://github.com/YOURLS/YOURLS
If you cloned a while ago, get the latest changes from upstream (aka "sync your fork")
git checkout <dev-branch> git pull upstream <dev-branch>
Create a new topic branch to contain your feature, change, or fix:
git checkout -b <my-awesome-feature>
Locally merge (or rebase) the upstream development branch into your topic branch:
git pull [--rebase] upstream master
Push your topic branch up to your fork:
git push origin <my-awesome-feature>
Open a Pull Request with a clear title and description.