diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..17521af9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,4 @@ +contact_links: + - name: Website + about: Visit the Javaistic website + url: https://javaistic.vercel.app/ diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 00000000..84d23cf0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,47 @@ +name: Documentation +description: Report problems and suggest ideas for the documentation +labels: [docs] + +body: + - type: markdown + attributes: + value: >- + Before opening a new issue, make sure it isn't covered by an existing issue. + Please search for [issues with the `docs` label][docs-issues] (including + closed issues) before you continue. + + + [docs-issues]: https://github.com/javaistic/javaistic/issues?q=is%3Aissue+label%3Adocs+is%3Aopen + + - type: dropdown + attributes: + label: Kind of Issue + description: >- + If your issue type is not here, select "other" and explain in the + "Description" field below. + options: [Improvement, Mistake, Other] + validations: + required: true + + - type: textarea + attributes: + label: Description + description: | + Include as much detail as possible, for example: + - A (perma)link to the docs in question + - Suggestions for how to change the docs + placeholder: "Example: The documentation doesn't cover my use case of the NPM package..." + validations: + required: true + + - type: dropdown + attributes: + label: Contributing + description: >- + This is an open source project and we welcome contributions. Do you want to + work on this issue? + options: + - 'Yes' + - 'No' + validations: + required: true \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..fe5ad99b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,14 @@ + + +**Issue:** + +### Description + + \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 45d257b2..b0459ad0 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -61,7 +61,7 @@ representative at an online or offline event. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at -[INSERT CONTACT METHOD]. +javaistic@gmail.com. All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the diff --git a/README.md b/README.md index 14fcc74f..f436c693 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,32 @@ -# **[Javaistic](https://javaistic.vercel.app/?utm_source=github&utm_medium=readme-header&utm_campaign=javaistic)   [](https://github.com/javaistic/javaistic/actions/workflows/codeql-analysis.yml)** +