5032901dfc
### _Why are the changes needed?_ Guidelines for Document and Code Contributions. - code style - documentation style - quick starts - sphinx-copybutton for copy button in code blocks - add kind:minor,help wanted,good first issue to doc issue template ### _How was this patch tested?_ - [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible - [x] Add screenshots for manual tests if appropriate <img width="1325" alt="image" src="https://user-images.githubusercontent.com/8326978/234193368-473e2a1d-2deb-4d91-901a-19cea58a489b.png"> - [x] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request Closes #4768 from yaooqinn/guide. Closes #4768 3a0bd395b [Kent Yao] Update docs/contributing/doc/build.rst 8fe4f6d14 [Kent Yao] Update docs/contributing/doc/build.rst a753bdde5 [Kent Yao] Guidelines for Document and Code contributions f8393fe8d [Kent Yao] Guidelines for Document and Code contributions 8f2d3ce82 [Kent Yao] Guidelines for Document and Code contributions 4f3a2128b [Kent Yao] Guidelines for Document and Code contributions Authored-by: Kent Yao <yao@apache.org> Signed-off-by: Cheng Pan <chengpan@apache.org>
86 lines
3.3 KiB
YAML
86 lines
3.3 KiB
YAML
#
|
|
# 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.
|
|
#
|
|
|
|
name: Documentation fixes or improvement
|
|
title: ":memo: Fix/Add <what> for <which> page"
|
|
description: Fix errors, or improve the content or refactor architecture of online documentation
|
|
labels: ["kind:documentation,kind:minor,help wanted,good first issue"]
|
|
body:
|
|
- type: checkboxes
|
|
attributes:
|
|
label: Code of Conduct
|
|
description: The Code of Conduct helps create a safe space for everyone. We require that everyone agrees to it.
|
|
options:
|
|
- label: >
|
|
I agree to follow this project's [Code of Conduct](https://www.apache.org/foundation/policies/conduct)
|
|
required: true
|
|
|
|
- type: checkboxes
|
|
attributes:
|
|
label: Search before asking
|
|
options:
|
|
- label: >
|
|
I have searched in the [issues](https://github.com/apache/kyuubi/issues?q=is%3Aissue) and found no similar
|
|
issues.
|
|
required: true
|
|
|
|
- type: dropdown
|
|
id: priority
|
|
attributes:
|
|
label: What type of changes will we make to the documentation?
|
|
options:
|
|
- Bugfixes
|
|
- Usage of New Feature
|
|
- Showcase
|
|
- Refactoring
|
|
- Typo, layout, grammar, spelling, punctuation errors, etc.
|
|
validations:
|
|
required: true
|
|
|
|
- type: input
|
|
id: versions
|
|
attributes:
|
|
label: Affects Version(s)
|
|
description: Which versions of Kyuubi Documentation are affected by this issue?
|
|
placeholder: e.g. master/1.5.0/1.4.1/...
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
attributes:
|
|
label: Improving the documentation
|
|
description: How do you think the documentation can be improved?
|
|
placeholder: >
|
|
Please include links to the documentation that you want to improve and possibly screenshots showing
|
|
the details. Explain why do you think it needs to improve. Make sure you include view of the target
|
|
audience of the documentation. Please explain why you think the docs are wrong.
|
|
|
|
- type: checkboxes
|
|
attributes:
|
|
label: Are you willing to submit PR?
|
|
description: >
|
|
A pull request is optional, but we are glad to help you in the contribution process
|
|
especially if you already know a good understanding of how to implement the fix.
|
|
Kyuubi is a community-driven project and we love to bring new contributors in.
|
|
options:
|
|
- label: Yes. I would be willing to submit a PR with guidance from the Kyuubi community to improve.
|
|
- label: No. I cannot submit a PR at this time.
|
|
|
|
- type: markdown
|
|
attributes:
|
|
value: "Thanks for taking the time to fill out this Doc improvement report!"
|