document.yml 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. #
  2. # Licensed to the Apache Software Foundation (ASF) under one or more
  3. # contributor license agreements. See the NOTICE file distributed with
  4. # this work for additional information regarding copyright ownership.
  5. # The ASF licenses this file to You under the Apache License, Version 2.0
  6. # (the "License"); you may not use this file except in compliance with
  7. # the License. You may obtain a copy of the License at
  8. #
  9. # http://www.apache.org/licenses/LICENSE-2.0
  10. #
  11. # Unless required by applicable law or agreed to in writing, software
  12. # distributed under the License is distributed on an "AS IS" BASIS,
  13. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. # See the License for the specific language governing permissions and
  15. # limitations under the License.
  16. name: Documentation Related
  17. description: Suggest an improvement or report a bug for this project's Documentation
  18. title: "[Doc][Module Name] Documentation bug or improvement"
  19. labels: [ "document", "Waiting for reply" ]
  20. body:
  21. - type: markdown
  22. attributes:
  23. value: |
  24. For better global communication, Please write in English.
  25. If you feel the description in English is not clear, then you can append description in Chinese, thanks!
  26. - type: checkboxes
  27. attributes:
  28. label: Search before asking
  29. description: >
  30. Please make sure to search in the [issues](https://github.com/apache/dolphinscheduler/issues?q=is%3Aissue) first
  31. to see whether the same feature was requested already.
  32. options:
  33. - label: >
  34. I had searched in the [issues](https://github.com/apache/dolphinscheduler/issues?q=is%3Aissue) and found no
  35. similar feature requirement.
  36. required: true
  37. - type: textarea
  38. attributes:
  39. label: Description
  40. description: A short description why your find in our document.
  41. - type: textarea
  42. attributes:
  43. label: Documentation Links
  44. description: Copy and paste one or more links of this documentation issue.
  45. - type: checkboxes
  46. attributes:
  47. label: Are you willing to submit a PR?
  48. description: >
  49. This is absolutely not required, but we are happy to guide you in the contribution process
  50. especially if you already have a good understanding of how to implement the improvement.
  51. DolphinScheduler is a totally community-driven project and we love to bring new contributors in.
  52. options:
  53. - label: Yes I am willing to submit a PR!
  54. - type: checkboxes
  55. attributes:
  56. label: Code of Conduct
  57. description: |
  58. The Code of Conduct helps create a safe space for everyone. We require that everyone agrees to it.
  59. options:
  60. - label: |
  61. I agree to follow this project's [Code of Conduct](https://www.apache.org/foundation/policies/conduct)
  62. required: true
  63. - type: markdown
  64. attributes:
  65. value: "Thanks for completing our form!"