From a4db2dd1a9e42e7f9d463ccb633d5952de18cc3f Mon Sep 17 00:00:00 2001 From: James Garner Date: Wed, 20 Nov 2024 12:06:14 +1300 Subject: [PATCH] docs(contributing): update CONTRIBUTING.md Update CONTRIBUTING.md to be a good landing page to be linked to by jujubot when replying to external contributor PRs. Also fix an error in a git command. --- docs/CONTRIBUTING.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index caa2d186e..ed6228348 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -42,7 +42,7 @@ Thanks for considering to contribute code to our project! We accept and welcome The process is very simple. - Fork the project into your account. - Clone your fork. -- Add an upstream remote: `git add upstream git@github.com:juju/python-libjuju.git` +- Add an upstream remote: `git remote add upstream git@github.com:juju/python-libjuju.git` - Check with `git remote -v`, origin should point to your fork, upstream should point to ours. - If your changes are going to be on top of a specific branch (e.g., `2.9`), then fetch and switch to that. - `git switch -c your-branch-name` @@ -52,6 +52,12 @@ The process is very simple. And that's it, just follow the link that Git will produce. We kindly ask you to follow our PR template (at least keep the sections there), so it can be faster for us to review and move it forward. +There are a few project specific things you may need to take care of so that your PR passes the automated testing. + - Check that all your [commits are signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). + - Use [Conventional Commits](https://github.com/juju/juju/blob/main/doc/CONTRIBUTING.md#conventional-commits) for commit messages, following the Juju project's [conventional commit types](https://github.com/juju/juju/blob/main/doc/conventional-commits.md). + - Please [sign the CLA](#contributor-licence-agreement) if you haven't already. + + #### What's next So when you create the PR, a bot might spam some messages there for admins to review the PR. Don't panic, everything's good. Someone from our team needs to push a button to allow for the CI to run.