This repository has been archived by the owner on Jan 16, 2020. It is now read-only.
Adds support file templates #18
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds/proposes the following standard repository templates:
- `LICENSE.md`, containing the license; replace `{year}` with the
current year during creation.
- `docs/CODE_OF_CONDUCT.md`. Formerly, this was `CONDUCT.md`, but GitHub
added support for identifying `CODE_OF_CONDUCT.md` several months ago.
- `docs/CONTRIBUTING.md`
- `docs/ISSUE_TEMPLATE.md`. This then acts as an issue template for
users submitting issues, and helps them determine whether they should
report or not.
- `docs/PULL_REQUEST_TEMPLATE.md`. This acts as a template for pull
request submissions, guiding the user to answer questions we need when
evaluating whether or not to merge.
- `docs/SUPPORT.md`. This new file provides the ability to detail
locations for different types of support.
GitHub allows a number of documents to be in either the root directory,
a hidden `.github/` directory, or the `docs/` directory. Pushing them
into the `docs/` directory serves two purposes:
- These files no longer litter the root directory.
- Our manual sources are usually under a `book/` subdirectory; if we
change the top-level subdirectory from `doc/` to `docs/`, then these
are grouped appropriately, and still segregated.
michalbundyra
approved these changes
Aug 3, 2017
template/docs/CONTRIBUTING.md
Outdated
| If you wish to contribute to this project, please be sure to | ||
| read/subscribe to the following resources: | ||
|
|
||
| - [Coding Standards](https://github.com/{org}/{repo}) |
There was a problem hiding this comment.
Should we have here link to coding standards repo?
There was a problem hiding this comment.
Yes; this was an accident! I'll fix that momentarily.
geerteltink
reviewed
Aug 4, 2017
| - Are you creating a new feature? | ||
| - Why is the new feature needed? What purpose does it serve? | ||
| - How will users use the new feature? | ||
|
|
There was a problem hiding this comment.
- Make sure you add only 1 new feature, multiple new features should be split in multiiple PR's.
- Add tests for the new feature.
| - Detail how the bug is invoked currently. | ||
| - Detail the original, incorrect behavior. | ||
| - Detail the new, expected behavior. | ||
|
|
There was a problem hiding this comment.
- Add regression tests to pinpoint the bug and prevent it from happening again.
Ocramius
reviewed
Aug 7, 2017
| @@ -0,0 +1,17 @@ | |||
| Provide a narrative description of what you are trying to accomplish: | |||
There was a problem hiding this comment.
Few things can be improved here:
- make everything a checkbox - makes it really easy for contributors, and we can later on parse it too, eventually
- add some text about the fact that they should check whether this goes to
develop,masteror a previous maintenance branch - add a checkbox to make sure the tests pass
- add a checkbox to make sure they wrote documentation, if this introduces feature behavior
- add a checkbox to make sure the
CHANGELOG.mdwas modified
|
Made changes as suggested by @xtreamwayz and @Ocramius . |
Ocramius
approved these changes
Aug 11, 2017
geerteltink
approved these changes
Aug 11, 2017
geerteltink
reviewed
Aug 18, 2017
| @@ -0,0 +1,11 @@ | |||
| Provide a narrative description of what you are trying to accomplish. | |||
There was a problem hiding this comment.
Can we add something like this at the top:
- I was not able to find an open or closed issue matching what I'm seeing.
- This is not a question as they should be asked on slack (Signup for Slack here) or our forums.
swap zendframework/maintainers with zendframework/<project>
|
Just mentioning here what I just saw: You can add hidden comments into the issue and pr templates. It might be handy for descriptions to explain things to the contributor but you don't want to add to each issue. Example: https://raw.githubusercontent.com/electron/electron/master/.github/ISSUE_TEMPLATE.md |
template/docs/SUPPORT.md
Outdated
| - For real-time questions, use our | ||
| [Slack](https://zendframework-slack.herokuapp.com) | ||
| - For detailed questions (e.g., those requiring examples) use our | ||
| [forums](https://discourse.zendframework.com/c/contributors) |
There was a problem hiding this comment.
I think the link here should depend on the package, and for expressive packages it should be:
https://discourse.zendframework.com/c/questions/expressive
and for other components:
https://discourse.zendframework.com/c/questions/components
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds/proposes the following standard repository templates:
LICENSE.md, containing the license; replace{year}with thecurrent year during creation.
docs/CODE_OF_CONDUCT.md. Formerly, this wasCONDUCT.md, but GitHubadded support for identifying
CODE_OF_CONDUCT.mdseveral months ago.docs/CONTRIBUTING.mddocs/ISSUE_TEMPLATE.md. This then acts as an issue template forusers submitting issues, and helps them determine whether they should
report or not.
docs/PULL_REQUEST_TEMPLATE.md. This acts as a template for pullrequest submissions, guiding the user to answer questions we need when
evaluating whether or not to merge.
docs/SUPPORT.md. This new file provides the ability to detaillocations for different types of support.
GitHub allows a number of documents to be in either the root directory,
a hidden
.github/directory, or thedocs/directory. Pushing theminto the
docs/directory serves two purposes:book/subdirectory; if wechange the top-level subdirectory from
doc/todocs/, then theseare grouped appropriately, and still segregated.