We are changing the contribution workflow for the PowerTOP project. All
of these changes are, or will be, documented in the CONTRIBUTE.md
document in the official PowerTOP repository. These changes are
What follows is a quick summary of what is documented in CONTRIBUTE.md.
## You Are Invited to Contribute
We want folks to know that contributions are welcome. Contributions are
welcome from anyone, anywhere.
## Use the GitHub Workflow
This is a big change, especially if you have tracked this project over
PowerTOP will use the GitHub collaboration flow. Any changes will be
submitted to the PowerTOP project as a Pull Request (PR) for review by
the community and maintainers.
Note that all Pull Requests (PRs) will be reviewed by the community and
maintainers. Changes will be merged after successful review and with
## Use the Linux Kernel Coding Style
The PowerTOP codebase will follow the Linux Kernel coding conventions.
We are aware this codebase has accumulated a backlog of style bugs, and
those will be worked over time.
## PowerTOP Is a GPLv2 Project
No sneaky changes have been made to this project's license. PowerTOP is
(still) licensed under the terms of the GNU General Public License (GPL)
CONTRIBUTE.md provides a license template to include in new source
Thanks for your continued interest in PowerTOP! We look forward to your
Nivedita, Gayatri, and Joe
From: Joe Konno <joe.konno(a)intel.com>
This series rewrites the README using markdown syntax and adds a
Series was submitted as a GitHub pull request as well:
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
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