We ❤️ Pull Requests for fixing issues or adding features. Thanks for your contribution!
Please read our code of conduct, which is based on
For small changes, especially documentation, you can simply use the "Edit" button to update the Markdown file, and start the pull request process. Use the preview tab in GitHub to make sure that it is properly formatted before committing. A pull request will cause integration tests to run automatically, so please review the results of the pipeline and correct any mistakes that are reported.
If you plan to contribute often or have a larger change to make, it is best to setup an environment for contribution, which is what the rest of these guidelines describe.
To prepare your dedicated GitHub repository:
-
Fork in GitHub https://github.com/tech-debt-burndown/CloudflarePages
-
Clone your forked repository (e.g.,
git clone git@github.com:yourname/CloudflarePages
) -
Set your remotes as follows:
cd CloudflarePages git remote add upstream git@github.com:tech-debt-burndown/CloudflarePages.git git remote set-url upstream --push DISABLED
Running
git remote -v
should give something similar to:origin git@github.com:yourname/CloudflarePages.git (fetch) origin git@github.com:yourname/CloudflarePages.git (push) upstream git@github.com:tech-debt-burndown/CloudflarePages.git (fetch) upstream DISABLED (push)
The use of
upstream --push DISABLED
is to prevent those withwrite
access to the main repository from accidentally pushing changes directly.
-
Fetch latest changes from main repository:
git fetch upstream
-
Reset your fork's
trunk
branch to exactly match upstreamtrunk
:git checkout trunk git reset --hard upstream/trunk git push --force
IMPORTANT: Do this only once, when you start working on new feature as the commands above will completely overwrite any local changes in
trunk
content. -
Edit, edit, edit, and commit your changes to Git:
# edit, edit, edit git add * git commit -m 'A useful commit message' git push
-
How to run tests:
# explain tests here
-
Open a new Pull Request to the main repository using your
trunk
branch