PR#294: Add contributing guide - fedpkg

fedpkg

#294 Add contributing guide

Merged 5 years ago by onosek. Opened 5 years ago by lsedlar.

lsedlar/fedpkg contributing into master

Add contributing guide

Lubomír Sedlář • 5 years ago

0045617

CONTRIBUTING.md

file added

+29

		`@@ -0,0 +1,29 @@`
		`+ # Contributing`
		`+`
		`+ We love seeing Pull Request from anyone.`
		`+`
		`+ For bigger or controversial changes, consider first discussing it via issue or`
		`+ any other method with the maintainers of this repository. Otherwise there's a`
		`+ risk they might disagree with it and you could spend time on it in vain. Or you`
		`+ can just open a Pull Request and keep the discussion there.`
		`+`
		`+`
		`+ ## Sign Off`
		`+`
		+ All commits must be signed-off on. Please use `git commit -s` to do that. This
		`+ serves as a confirmation that you have the right to submit your changes. See`
		`+ [Developer Certificate of Origin][0] for details.`
		`+`
		`+ [0]: https://developercertificate.org/`
		`+`
		`+`
		`+ ## Other tips`
		`+`
		`+ You can increase the chance of your PR being merged by:`
		`+`
		`+ * having good test coverage`
		`+ * writing documentation`
		`+ * following PEP 8 for code formatting`
		`+ * writing [a good commit message][1]`
		`+`
		`+ [1]: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html`

MANIFEST.in

file modified

+1 -1

		`@@ -1,4 +1,4 @@`
		`- include COPYING README git-changelog CHANGELOG.rst`
		`+ include COPYING README git-changelog CHANGELOG.rst CONTRIBUTING`
		`include doc/fedpkg_man_page.py`
		`include doc/release-guide.markdown`
		`include test/utils.py`

lsedlar commented 5 years ago

Rendered version: https://pagure.io/fork/lsedlar/fedpkg/blob/contributing/f/CONTRIBUTING.md

Fixes: https://pagure.io/fedpkg/issue/293

onosek commented 5 years ago

Thanks, looks good. Should this file be also part of dist package (.tar.bz2)? If so, probably MANIFEST.in has to be updated.

Edited 5 years ago by onosek

cqi commented 5 years ago

I think it would be good to include everything into Python source dist package so that when anyone gets that package, he/she can get everything from source tree.

rebased onto 0045617

5 years ago