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

docs: contrib/issue templates #2377

Merged
merged 6 commits into from
Aug 17, 2020
Merged

docs: contrib/issue templates #2377

merged 6 commits into from
Aug 17, 2020

Conversation

henryiii
Copy link
Collaborator

@henryiii henryiii commented Aug 10, 2020

This sets up some GitHub specifics to make the main pages a little cleaner, add nice issue templates and a prominent link to the gitter, and adds information requested by @rwgk about setting up development environments and building with CMake.

A second PR can be made to move CONTRIBUTING.md to .github/CONTRIBUTING.md , to save a little space on the main page. We can add a nice link to it from README.md.

@YannickJadoul
Copy link
Collaborator

Is it urgent to move CONTRIBUTING.md to .github? I've often seen it at the root?

Apart from that, I'm OK with this, but this isn't too urgent and I can imagine @wjakob wants to have a say/some input in this? So I'd suggest waiting before merging this until we can get some feedback?

@henryiii
Copy link
Collaborator Author

It was @wjakob's suggestion that we clean up the main folder a bit, though have no idea if likes CONTRIBUTING.md in the main folder or not. I am slightly in favor of the .github location for it, since it still shows up in all the proper GitHub prompts (that's true in either place) and keeps the main folder slightly cleaner. We can always link to it from the README, etc., if it needs to be more obvious.

No rush, agreed.

@YannickJadoul
Copy link
Collaborator

(Just assigning to @wjakob, so he can have a clear overview, in a few weeks)

Copy link
Collaborator

@rwgk rwgk left a comment

Choose a reason for hiding this comment

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

Thanks Henry, this looks great to me, just a few small suggestions.

How much trouble is it to move CONTRIBUTING.md in a separate PR: a pure move no changes?
That way it's easiest to see what changed.

@henryiii henryiii changed the title Contrib/issue templates docs: contrib/issue templates Aug 15, 2020
@henryiii
Copy link
Collaborator Author

I've moved it back - we can move it later.

@wjakob
Copy link
Member

wjakob commented Aug 17, 2020

Looks all good to me, and moving the github-related markdown files to a .github sub-directory is great.

@henryiii
Copy link
Collaborator Author

I'll do the move in a separate PR.

@henryiii henryiii merged commit 6404099 into pybind:master Aug 17, 2020
@henryiii henryiii deleted the docs/contrib branch August 17, 2020 14:14
rwgk pushed a commit that referenced this pull request Jan 15, 2022
Typo introduced with PR #2377.

Adopting fix from @AWhetter PR #2621 (to keep unrelated changes cleanly separated).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants