olamy commented on code in PR #588: URL: https://github.com/apache/maven-site/pull/588#discussion_r1874728401
########## content/markdown/developers/conventions/github.md: ########## @@ -0,0 +1,102 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> +# Maven GitHub Conventions + +This document describes how Maven developers and contributors should use GitHub Issues and Pull Request. + +## GitHub Issues, Pull Request - Recommendations. + +**Minor changes** such as code reformatting, documentation fixes, etc. that aren't going to impact other users +can be committed without a GitHub Issue, but Pull Request is recommended. + +**Larger changes** such as bug fixes, API changes, significant refactoring, new classes, and pretty much any change Review Comment: I would use the opportunity to have a process as simple as possible. In the gihub model a PR is an extension of an issue so why asking someone who already creating a PR with explaining the problem and provide a solution, to create an issue with exactly the same content as the PR. Looks really redundant to me and possible issue if not having both entries in sync. I would keep issues only for people reporting issue without any PR or for future idea we would like to implement, At the end of the day as described in this document, the release notes will be generated from PRs. So let;s make this as simple as possible -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@maven.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
