Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve issue templates #3367

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .github/ISSUE_TEMPLATE/02-name-correction.yml
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could be useful to link the submitter to our documentation on this: https://github.com/acl-org/acl-anthology/wiki/Name-Variants

Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ body:
description: |
Please provide as much information as possible to help us fix the issue. For example:
- Describe what the correct author page(s) should look like.
- Provide a link to the academic website of the author(s) that helps us verify their current name or publication list.
- If there are multiple spellings of the name, indicate which spelling of the name is the preferred/canonical one. _(e.g. if you are submitting a correction for yourself)_
- Provide a link to the academic website of the author(s) that helps us verify their current name.
- If there are multiple people with the same name, list the Anthology IDs of all papers belonging to one person, as well as their affiliation, if possible. _(The affiliation of an author can help us disambiguate their publications in the future.)_
- If there are multiple names for the same person, indicate which spelling of the name is the preferred one. _(We can merge author pages with different names if they refer to the same person, but note that we consider the name as written in the PDF as the canonical one for that publication.)_
validations:
required: true
4 changes: 3 additions & 1 deletion .github/ISSUE_TEMPLATE/03-revision-or-errata.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,9 @@ body:
description: |
Please provide the PDF containing the revision or erratum, either by providing a link or uploading it directly within the textbox below.

Note that the ACL Anthology **cannot change the content of PDF files.** To file a revision, you need to provide an updated version of the PDF file yourself.
- The ACL Anthology **cannot change the content of PDF files.** You need to provide an updated version of the PDF file yourself.
- The ACL Anthology **cannot add footers or page numbers to PDFs.** For \*ACL papers, you may find [this template from ACLPUB2](https://github.com/rycolab/aclpub2/blob/main/aclpub2/templates/watermarked_pdf.tex) useful for recreating this information yourself.
- We do **not** accept PDFs with arXiv watermarks.
placeholder: |
(Provide a link or use the "Attach an image or video" button to attach the PDF file directly.)
validations:
Expand Down
2 changes: 1 addition & 1 deletion hugo/content/info/corrections.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ For requests to change paper *content* (either a revision or an erratum), again,
Its intended audience is users of the Anthology, and should therefore be written from a neutral, scientific perspective.
- If the metadata also needs to change, please also follow the instructions in the previous section.
- If possible, when generating your revision, it would be good to add the proper proceedings header and footer stamps, as well as the correct page numbering.
Unfortunately, we cannot provide any assistance with this task.
Unfortunately, we cannot provide any assistance with this task, but [this template from the ACLPUB2 repo](https://github.com/rycolab/aclpub2/blob/main/aclpub2/templates/watermarked_pdf.tex) may be helpful for this.

For revisions, the brief summary should allow readers to find the changed parts, but need not be too detailed.
Here are some good examples:
Expand Down
Loading