Skip to content

Commit

Permalink
Merge pull request #1201 from james-garner-canonical/2024-11/docs/upd…
Browse files Browse the repository at this point in the history
…ate-contributing-md

#1201

To support improving the jujubot auto-reply on external contributor PRs (see #1188), update our CONTRIBUTING.md to be a good landing page to be linked to. Also fix an error in a git command [noticed by a contributor](#1188 (comment)).

#### QA Steps

Proofread docs.

#### Notes & Discussion

Need to look into how to update jujubot config for this repo.
  • Loading branch information
jujubot authored Nov 20, 2024
2 parents 6a62d83 + a4db2dd commit 491d2a1
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected]:juju/python-libjuju.git`
- Add an upstream remote: `git remote add upstream [email protected]: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`
Expand All @@ -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.
Expand Down

0 comments on commit 491d2a1

Please sign in to comment.