ascheman commented on code in PR #588: URL: https://github.com/apache/maven-site/pull/588#discussion_r1878630384
########## content/markdown/developers/conventions/github.md: ########## @@ -0,0 +1,106 @@ +<!-- +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 Issue, 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 +of more than 100 lines, and **New feature** should have GitHub Issue in order to first discus planed change. + +GitHub Issue should be referenced in commit message by `#issue-number`. + +GitHub Issue and Pull Request should have a label with type, like `bug`, `enhancement` and so on. +Pull Request without labels will be not categorized in Release Notes. Review Comment: You will need write access to the repository to edit labels, which usually is not the case for contributors, but only for committers. You could have an action which is bound to a custom slash command, like 1. contributor wants a label added by adding a comment with `/request-label feature` 2. committer approves the label request with `/approve-label` (which could also be auto-approved by rules) That said, I doubt that many contributors would make use of it, since it is very uncommon and only very few people know about it. On the other hand it is not much work and probably worth a try. The question then is to educate contributors to learn and use the feature. Personal opinion: Perhaps it is rather possible to have some AI (GH action) to evaluate PRs and propose or labels or even auto-assign labels based on the contents. -- 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
