Skip to content

Rewrite README, and contribution guide

Joe Konno powertop 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest3 patches 3 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/3README.md: rename, add md syntax, and major tweaksREADME README.md+204 -1572 replies
2/3README.md: Fix a misspelled nameREADME.md+1 -10 replies
3/3Add CONTRIBUTE.mdCONTRIBUTE.md+188 -00 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [Powertop] [PATCH 0/3 v1] Rewrite README, and contribution guide

From: Joe Konno <joe.konno(a)intel.com>

This series rewrites the README using markdown syntax and adds a contribution guide.

Series was submitted as a GitHub pull request as well:
* https://github.com/fenrus75/powertop/pull/43

Thanks to my colleague, Doug Martin, for reviewing these changes.

CONTRIBUTE.md changes up development workflows in (hopefully) a good way. In my opinion, these are the key take-aways from that document:
* Use GitHub workflows for sharing/collaborating (e.g. PRs, Issues)
* Use the Linux kernel coding style

The README and CONTRIBUTE documents will continue to evolve, but this should get us going in the right direction.

PS: PowerTOP's project description on GitHub ("please post patches to the mailing list instead of using github pull requests") will be changed after this series is merged-- if it is.

Joe Konno (3):
README.md: rename, add md syntax, and major tweaks README.md: Fix a misspelled name
Add CONTRIBUTE.md

 CONTRIBUTE.md | 188 ++++++++++++++++++++++++++++++++++++++++++++++
 README        | 157 --------------------------------------
 README.md     | 204 ++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 392 insertions(+), 157 deletions(-)
 create mode 100644 CONTRIBUTE.md
 delete mode 100644 README
 create mode 100644 README.md
Signature · 1 line
2.26.2