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

Add PEPs Contributing Guideline, CoC, and PR template #712

Merged
merged 8 commits into from
Jul 9, 2018

Conversation

Mariatta
Copy link
Member

@Mariatta Mariatta commented Jul 9, 2018

Closes #706

Copy link
Member

@gvanrossum gvanrossum left a comment

Choose a reason for hiding this comment

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

Thank you! But can we move the files to the top level (i.e. not inside .github)? I'd like them to be a bit more discoverable when I do a plain ls on the directory.


To learn more about the purpose of PEPs and how to go about writing a PEP, please
start reading at PEP 1 (pep-0001.txt in this repo). Note that PEP 0, the index PEP,
is now automatically generated, and not committed to the repo.
Copy link
Member

Choose a reason for hiding this comment

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

I'd like to see a (strong) suggestion added here to first discuss an idea on python-ideas before attempting to write a PEP.

@Mariatta
Copy link
Member Author

Mariatta commented Jul 9, 2018

No prob!
I've kept COC and PR template in .github directory, but moved CONTRIBUTING.rst to the root level.
I also linked it from README.rst.

@Mariatta
Copy link
Member Author

Mariatta commented Jul 9, 2018

And if we find people continuing to forgot about the PEP number, I can write a bot to check for it 😄

@gvanrossum
Copy link
Member

What's the reason for keeping the other two in the .github subdir? In mypy we have ISSUE_TEMPLATE.md at the top level and it works fine. (I guess I am just in disagreement with GitHub's recommendation to hide these files from view.)

@Mariatta
Copy link
Member Author

Mariatta commented Jul 9, 2018

The templates will work in both root level or inside .github.
I just wanted to keep the root level clean of unnecessary things.

In my mind, the templates are really not relevant unless you're on GitHub web UI, opening an issue or PR, so I think these should remain in .github folder.

But I can move the CoC to the root.

@gvanrossum
Copy link
Member

Sorry. I see (for the first time now :-) that the cpython repo has a .github directory, so I withdraw my objection. I do think that the COC (here as well as there) belongs at the top level, since I would hope that people using the repo without using GitHub still ought to be reminded of the COC.

Add CoC to contributing guidelines.
@Mariatta
Copy link
Member Author

Mariatta commented Jul 9, 2018

Moved Code_of_conduct.rst to root level.
I saw that CPython's contributing guideline also mentions CoC, so I copied the text here too.

Copy link
Member

@gvanrossum gvanrossum left a comment

Choose a reason for hiding this comment

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

Great!

Mariatta added a commit to Mariatta/cpython that referenced this pull request Jul 9, 2018
Follow up from python/peps#712 (comment):

"people using the repo without using GitHub still ought to be reminded of the COC" - GvR
@Mariatta Mariatta merged commit 4abf9ef into master Jul 9, 2018
@Mariatta Mariatta deleted the add-contributing-guide branch July 9, 2018 21:01
Mariatta added a commit to python/cpython that referenced this pull request Jul 9, 2018
Follow up from python/peps#712 (comment):

"people using the repo without using GitHub still ought to be reminded of the COC" - GvR
@Mariatta Mariatta mentioned this pull request Jul 10, 2018
3 tasks
edo38 pushed a commit to edo38/python-clinic that referenced this pull request Apr 24, 2024
Follow up from python/peps#712 (comment):

"people using the repo without using GitHub still ought to be reminded of the COC" - GvR
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants