Add API section to README; add HACKING.md; remove Makefile #67
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hpidcock
reviewed
Sep 15, 2021
|
|
||
| ... and enjoy the rest of 2021! | ||
| We welcome quality external contributions. We have good unit tests for much of the code, and a thorough code review process. Please note that unless it's a trivial fix, it's generally worth opening an issue to discuss before submitting a pull request. |
There was a problem hiding this comment.
Probably mention Ubuntu CoC and how to sign the CoC https://help.ubuntu.com/community/SigningCodeofConduct
There was a problem hiding this comment.
I'm not sure signing a CoC should be necessary for submitting a pull request. However, it looks like other Canonical projects (including snapd) require signing the Canonical Contributor License Agreement -- I'm guessing we probably want to do the same here, so I've added a link to that.
|
@niemeyer These are just lightweight documentation changes (and I believe you were already in favour of getting rid of the Makefile), so I'll go ahead and merge -- we can easily tweak later as needed. |
benhoyt
added a commit
to benhoyt/juju
that referenced
this pull request
Oct 1, 2021
More specifically, these PRs: * canonical/pebble#59 Add GPLv3 license (to match source header and snapd) * canonical/pebble#64 Avoid use of multipart.Part.FileName() to fix files API on Go 1.17 * canonical/pebble#63 Add wait-change API endpoint and client function * canonical/pebble#65 Make Pebble "go vet" clean * canonical/pebble#66 Remove a bunch of snapd references * canonical/pebble#67 Add API section to README; add HACKING.md; remove Makefile * canonical/pebble#60 Add Replan operation to restart changed services. * canonical/pebble#61 One-shot commands (pebble exec)
jujubot
added a commit
to juju/juju
that referenced
this pull request
Oct 4, 2021
#13381 Includes these Pebble PRs: * canonical/pebble#59 * canonical/pebble#64 * canonical/pebble#63 * canonical/pebble#65 * canonical/pebble#66 * canonical/pebble#67 * canonical/pebble#60 * canonical/pebble#61
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
README.md, most notably adding a brief description of the API and its clients.HACKING.mdfor developers to more easily get into the project.gocommands the Pebble developers actually use (and whichHACKING.mdnow details).