Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(maint) Add CONTRIBUTING and Maintenance doc sections #403

Merged
merged 1 commit into from
Apr 25, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# How to contribute

Third-party patches are essential for keeping Puppet open-source projects
great. We want to keep it as easy as possible to contribute changes that
allow you to get the most out of our projects. There are a few guidelines
that we need contributors to follow so that we can have a chance of keeping on
top of things. For more info, see our canonical guide to contributing:

[https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md](https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Someday we should probably put that on puppet.com, or somewhere that's not the Puppet repo.

11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -346,6 +346,16 @@ Don't become a daemon and execute on foreground on the associated terminal.

The path of the PID file; the default is */var/run/puppetlabs/pxp-agent.pid*

## Maintenance

Maintainers: Alessandro Parisi <[email protected]>, Michael Smith
<[email protected]>, Michal Ruzicka <[email protected]>.

Contributing: Please refer to [this](contributing) document.

Tickets: File bug tickets at https://tickets.puppet.com/browse/PCP and add the
`pxp-agent` component to the ticket.

[cpp-pcp-client]: https://github.com/puppetlabs/cpp-pcp-client
[leatherman]: https://github.com/puppetlabs/leatherman
[nssm]: https://nssm.cc
Expand All @@ -365,3 +375,4 @@ The path of the PID file; the default is */var/run/puppetlabs/pxp-agent.pid*
[7zip-choco]: https://chocolatey.org/packages/7zip.commandline
[MinGW-w64-choco]: https://chocolatey.org/packages/mingw
[Boost-download]: http://sourceforge.net/projects/boost/files/latest/download
[contributing]: CONTRIBUTING.md