This is an automated email from the ASF dual-hosted git repository.
wilfred-s pushed a commit to branch branch-1.9
in repository
https://gitbox.apache.org/repos/asf/yunikorn-scheduler-interface.git
The following commit(s) were added to refs/heads/branch-1.9 by this push:
new 1edd16c [YUNIKORN-3194] Update PR template to ask about AI
contribution (#160)
1edd16c is described below
commit 1edd16cdaee8cba0629f71b0f6529bc0e69e0d70
Author: Wilfred Spiegelenburg <[email protected]>
AuthorDate: Fri Jun 19 15:55:41 2026 +1000
[YUNIKORN-3194] Update PR template to ask about AI contribution (#160)
Update PR template:
* ask about AI contribution
* Update Jira area
* Check for testing performed (new make target to simplify task)
Closes: #160
Signed-off-by: Wilfred Spiegelenburg <[email protected]>
(cherry picked from commit 7fddf36d2206ca7875946c85da864df216952ab5)
---
.github/PULL_REQUEST_TEMPLATE | 50 ++++++++++++++++++++++++++-----------------
Makefile | 13 ++++-------
lib/go/Makefile | 5 ++---
3 files changed, 36 insertions(+), 32 deletions(-)
diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE
index 0d56d00..b070a11 100644
--- a/.github/PULL_REQUEST_TEMPLATE
+++ b/.github/PULL_REQUEST_TEMPLATE
@@ -1,28 +1,38 @@
-### What is this PR for?
-A few sentences describing the overall goals of the pull request's commits.
-First time? Check out the contributing guide -
http://yunikorn.apache.org/community/how_to_contribute
+### Description
+Short description of this pull request, can be as simple as the commit message
used.
+First time contributing? Check out the contributing guide:
https://yunikorn.apache.org/community/how_to_contribute
-### What type of PR is it?
-* [ ] - Bug Fix
-* [ ] - Improvement
-* [ ] - Feature
-* [ ] - Documentation
-* [ ] - Hot Fix
-* [ ] - Refactoring
+### Type of change
+Please delete options that are not relevant.
-### Todos
-* [ ] - Task
+- [ ] Bug Fix
+- [ ] Improvement
+- [ ] Feature
+- [ ] Refactoring
+- [ ] Documentation
-### What is the Jira issue?
-* Open an issue on Jira https://issues.apache.org/jira/browse/YUNIKORN/
-* Put link here, and add [YUNIKORN-*Jira number*] in PR title, eg.
`[YUNIKORN-2] Gang scheduling interface parameters`
+### Jira issue
+Jira ID : https://issues.apache.org/jira/browse/YUNIKORN-XXXXX
-### How should this be tested?
+- [ ] I have created a Jira issue for this pull request.
+- [ ] The Jira ID is part of the title of this pull request.
-### Screenshots (if appropriate)
+### AI Tooling
+If an AI tool was used:
+- [ ] The PR includes the phrase "Generated by \<tool>", where \<tool> is the
name of the AI tool used.
+- [ ] My use of AI contributions follows the ASF legal policy.
+
+Check https://www.apache.org/legal/generative-tooling.html for details.
+
+### How has this been tested?
+- [ ] New unit tests were added to cover new or changed code paths.
+- [ ] `make build` was run to regenerate the proto files.
+- [ ] `make test` was run, and no failures reported.
### Questions:
-* [ ] - The licenses files need update.
-* [ ] - There is breaking changes for older versions.
-* [ ] - It needs documentation.
+- [ ] The change needs documentation, a pull request for apache/yunikorn-site
repository will be created.
+- [ ] There is breaking changes for older versions: jira is tagged with
`release-notes` label.
+- [ ] The licenses files needs to be updated.
+
+### Screenshots or other details
diff --git a/Makefile b/Makefile
index f604242..49df31c 100644
--- a/Makefile
+++ b/Makefile
@@ -16,10 +16,12 @@
# limitations under the License.
#
+.PHONY: test check license-check clean clobber
+
# Check if this GO tools version used is at least the version of go specified
in
# the go.mod file. The version in go.mod should be in sync with other repos.
GO_VERSION := $(shell go version | awk '{print substr($$3, 3, 4)}')
-MOD_VERSION := $(shell cat .go_version)
+MOD_VERSION := $(shell cat .go_version)
GM := $(word 1,$(subst ., ,$(GO_VERSION)))
MM := $(word 1,$(subst ., ,$(MOD_VERSION)))
@@ -114,14 +116,10 @@ $(INTERFACE_TMP): $(SI_SPEC)
build: $(SI_PROTO).tmp $(CONSTANTS_TMP) $(INTERFACE_TMP)
$(MAKE) -C $(LIB_DIR)
-# Set a empty recipe
-.PHONY: test
-test:
- @echo ""
+test: license-check check
# Check that the updates are made in the source file: scheduler-interface.md
# The check is run as part of the pre-commit and a build should not update any
files.
-.PHONY: check
check: build
@echo "Check for changes by build"
@if ! git diff --quiet; then \
@@ -135,7 +133,6 @@ check: build
OS := $(shell uname -s | tr '[:upper:]' '[:lower:]')
# Check for missing license headers
-.PHONY: license-check
license-check:
@echo "checking license headers:"
ifeq (darwin,$(OS))
@@ -153,7 +150,6 @@ endif
@echo " all OK"
# Simple clean of generated files only (no local cleanup).
-.PHONY: clean
clean:
rm -rf $(CONSTANTS_GO)
rm -rf $(INTERFACE_GO)
@@ -162,7 +158,6 @@ clean:
# Remove all non versioned files,
# Running this target will trigger a re-install of protoc etc in te next build
cycle.
-.PHONY: clobber
clobber: clean
cd $(BASE_DIR) && \
$(MAKE) -C $(LIB_DIR) $@
diff --git a/lib/go/Makefile b/lib/go/Makefile
index 7261c8b..9f6a203 100644
--- a/lib/go/Makefile
+++ b/lib/go/Makefile
@@ -20,6 +20,8 @@ ifndef PROTOBUF_VERSION
$(error PROTOBUF_VERSION is missing)
endif
+.PHONY: syntax_check clean clobber
+
all: build
# Build everything under the local directory.
@@ -121,7 +123,6 @@ $(SI_GO_TMP): $(SI_PROTO) | $(PROTOC) $(PROTOC_GEN_GO)
$(PROTOC_GEN_GO_GRPC)
# Syntax check constants to make sure it passes
COMMON_DIR := ./common
-.PHONY: syntax_check
syntax_check:
@echo "\nsyntax check for constants code"
@go build $(COMMON_DIR) > /dev/null
@@ -133,11 +134,9 @@ build: $(SI_GO_TMP) syntax_check
@echo "\nprotobuf go source
generated:\n\t$(HERE)/$(SI_GO)\n\t$(HERE)/$(SI_GRPC_GO)\n"
# Simple clean of generated file language binding.
-.PHONY: clean
clean:
rm -rf $(SI_GO) $(SI_GO_TMP) $(SI_BUILD)
# Remove all non versioned files (including compiler and cache)
-.PHONY: clobber
clobber: clean
rm -rf $(PROTOC_TMP_DIR)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
