Skip to content

Update creating-an-issue.md#23536

Merged
cmwilson21 merged 4 commits intogithub:mainfrom
amandamartin-dev:patch-1
Jan 31, 2023
Merged

Update creating-an-issue.md#23536
cmwilson21 merged 4 commits intogithub:mainfrom
amandamartin-dev:patch-1

Conversation

@amandamartin-dev
Copy link
Copy Markdown
Contributor

Why:

Closes #22835

What's being changed (if available, include any code snippets, screenshots, or gifs):

Adding a tip that query parameters also work for custom fields in issue template creation on line 173 just below the query parameters table

Check off the following:

  • I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • For content changes, I have completed the self-review checklist.

Adding a tip that query parameters also work for custom fields in issue template creation on line 173

Fixes github#22835 
Closes github#22835
@welcome
Copy link
Copy Markdown

welcome Bot commented Jan 27, 2023

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Jan 27, 2023
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 27, 2023

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
issues/tracking-your-work-with-issues/creating-an-issue.md fpt
ghec
ghes@ 3.7 3.6 3.5 3.4 3.3
ghae
fpt
ghec
ghes@ 3.7 3.6 3.5 3.4 3.3
ghae

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server
ghae: GitHub AE

@cmwilson21 cmwilson21 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review issues Content related to issues and removed triage Do not begin working on this issue until triaged by the team labels Jan 30, 2023
@cmwilson21
Copy link
Copy Markdown
Contributor

@amandamartin-dev Thanks for submitting a PR to fix your issue! 👍

I'll get this triaged for review! ⚡

Copy link
Copy Markdown
Contributor

@saritai saritai left a comment

Choose a reason for hiding this comment

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

@amandamartin-dev Thanks so much for opening this PR! ✨ Your addition looked good - however, I looked into this a bit further and I think the information you were looking for is already there (the paragraph under the table of query parameters), but the language could definitely be improved as it was a bit unclear and easy to miss!

Basically, custom fields can be defined in YAML issue forms (not the original Markdown issue templates), and YAML issue templates are only supported for GitHub.com and Enterprise Cloud (not yet Enterprise Server).

I have added a suggestion to update that paragraph using some of the language that you originally added, to make it clearer! Take a look at the preview and let me know if that looks good to you - if you think it still might be unclear, we could try putting it in "Tip" form as well. 👍

Comment thread content/issues/tracking-your-work-with-issues/creating-an-issue.md Outdated
Comment thread content/issues/tracking-your-work-with-issues/creating-an-issue.md Outdated
@saritai saritai removed the waiting for review Issue/PR is waiting for a writer's review label Jan 30, 2023
@cmwilson21 cmwilson21 added the more-information-needed More information is needed to complete review label Jan 30, 2023
…e.md


modify description to be more descriptive of where query params can be used

Co-authored-by: Sarita Iyer <66540150+saritai@users.noreply.github.com>
Comment thread content/issues/tracking-your-work-with-issues/creating-an-issue.md Outdated
@saritai
Copy link
Copy Markdown
Contributor

saritai commented Jan 31, 2023

@amandamartin-dev Awesome, looks good to me! Marking this as ready to merge - thanks again for catching this and opening this PR! ✨

@saritai saritai added ready to merge This pull request is ready to merge and removed more-information-needed More information is needed to complete review labels Jan 31, 2023
@cmwilson21 cmwilson21 enabled auto-merge January 31, 2023 16:51
@cmwilson21 cmwilson21 merged commit e7da33f into github:main Jan 31, 2023
@github-actions
Copy link
Copy Markdown
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content This issue or pull request belongs to the Docs Content team issues Content related to issues ready to merge This pull request is ready to merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add custom field support info for url parameters in issue creation

4 participants