Skip to content

/ peps

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

Jump to bottom

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

Merged
merged 8 commits into from Jul 9, 2018
Merged

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

merged 8 commits into from Jul 9, 2018

Conversation

@Mariatta
Copy link
Member

@Mariatta Mariatta commented Jul 9, 2018

Closes #706
@Mariatta
Add PEPs Contributing Guideline, CoC, and PR template
Verified
This commit was signed with a verified signature.
Mariatta Mariatta Wijaya
GPG key ID: BA945C6FDC901250 Learn about signing commits
Loading status checks…
2fc1b7f 
Closes #706
@gvanrossum
gvanrossum reviewed Jul 9, 2018
View changes
Copy link
Member

@gvanrossum gvanrossum left a comment •
edited

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.
.github/contributing.rst Outdated

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.

This comment has been minimized.

Sign in to view
@gvanrossum

gvanrossum Jul 9, 2018
Member

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 added 3 commits Jul 9, 2018
@Mariatta
Move CONTRIBUTING.rst to top level folder.
Verified
This commit was signed with a verified signature.
Mariatta Mariatta Wijaya
GPG key ID: BA945C6FDC901250 Learn about signing commits
Loading status checks…
4cb95e3 
Link to CONTRIBUTING.rst from README.rst
@Mariatta
Missed an underscore.
Verified
This commit was signed with a verified signature.
Mariatta Mariatta Wijaya
GPG key ID: BA945C6FDC901250 Learn about signing commits
Loading status checks…
ba1e30e
@Mariatta
Pluralize.
Verified
This commit was signed with a verified signature.
Mariatta Mariatta Wijaya
GPG key ID: BA945C6FDC901250 Learn about signing commits
Loading status checks…
46987fd
@Mariatta
Copy link
Member Author

@Mariatta 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 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

@gvanrossum gvanrossum commented Jul 9, 2018

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 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

@gvanrossum gvanrossum commented Jul 9, 2018

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.
@Mariatta
Move CoC.rst to root level.
Verified
This commit was signed with a verified signature.
Mariatta Mariatta Wijaya
GPG key ID: BA945C6FDC901250 Learn about signing commits
Loading status checks…
1c9126f 
Add CoC to contributing guidelines.
@Mariatta
Copy link
Member Author

@Mariatta 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.
@gvanrossum
gvanrossum approved these changes Jul 9, 2018
View changes
Copy link
Member

@gvanrossum gvanrossum left a comment

Great!
Mariatta added 3 commits Jul 9, 2018
@Mariatta
Proper rst
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
Loading status checks…
16464db
@Mariatta
link to PEP 1
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
Loading status checks…
6cb459c
@Mariatta
Double backticks
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
Loading status checks…
148ccdc
Mariatta added a commit to Mariatta/cpython that referenced this pull request Jul 9, 2018
@Mariatta
Move Code_of_Conduct.rst to the root level.
Verified
This commit was signed with a verified signature.
Mariatta Mariatta Wijaya
GPG key ID: BA945C6FDC901250 Learn about signing commits
Loading status checks…
4306994 
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 9, 2018
Merged
@Mariatta Mariatta merged commit 4abf9ef into master Jul 9, 2018
2 checks passed
2 checks passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details
@Mariatta Mariatta deleted the add-contributing-guide branch Jul 9, 2018
Mariatta added a commit to python/cpython that referenced this pull request Jul 9, 2018
@Mariatta
Move Code_of_Conduct.rst to the root level. (GH-8209)
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
Loading status checks…
3ed9192 
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
Closed
0 of 3 tasks complete
lisroach added a commit to lisroach/cpython that referenced this pull request Sep 10, 2018
@Mariatta @lisroach
Move Code_of_Conduct.rst to the root level. (pythonGH-8209)
f48590f 
Follow up from python/peps#712 (comment):

"people using the repo without using GitHub still ought to be reminded of the COC" - GvR
yahya-abou-imran added a commit to yahya-abou-imran/cpython that referenced this pull request Nov 2, 2018
@Mariatta @yahya-abou-imran
Move Code_of_Conduct.rst to the root level. (pythonGH-8209)
d848826 
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
Reviewers

@gvanrossum gvanrossum

Assignees
No one assigned
Labels
CLA signed
Projects
None yet
Milestone
No milestone
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
@Mariatta @gvanrossum @the-knights-who-say-ni