10000 Github: Refactor issue forms to YAML by cakegod · Pull Request #491 · TheOdinProject/javascript-exercises · GitHub
[go: up one dir, main page]

Skip to content

Github: Refactor issue forms to YAML #491

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

Merged
merged 16 commits into from
Sep 4, 2024

Conversation

cakegod
Copy link
Contributor
@cakegod cakegod commented Sep 1, 2024

Because

Makes opening issues faster and easier.

This PR

Refactors the two issue forms to the new YAML issue form template.

Issue

Closes #487

Additional Information

Open to further refinements

Pull Request Requirements

  • I have thoroughly read and understand The Odin Project Contributing Guide
  • The title of this PR follows the location of change: brief description of change format, e.g. 01_helloWorld: Update test cases
  • The Because section summarizes the reason for this PR
  • The This PR section has a bullet point list describing the changes in this PR
  • If this PR addresses an open issue, it is linked in the Issue section
  • If this PR includes any changes that affect the solution of an exercise, I've also updated the solution in the /solutions folder

Copy link
Contributor
@MaoShizhong MaoShizhong left a comment

Choose a reason for hiding this comment

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

🙏

Comment on lines 45 to 54
value: |
1. Step 1
2. Step 2
3. Step 3

E.g.:
1. Log in
2. Visit a lesson page
3. Click the complete button
4. The complete button does not update
Copy link
Contributor

Choose a reason for hiding this comment

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

We should make this a placeholder instead (same for the other ones in this file and the feature request one.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's what I tried first with the checkboxes list. The list in the placeholder renders in a single line, which looks odd. I'll check what we can do about that.

Copy link
Contributor

Choose a reason for hiding this comment

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

https://github.com/TheOdinProject/theodinproject/blob/main/.github/ISSUE_TEMPLATE/feature_request.yaml?plain=1

The website repo feature request form just does what you did but with placeholder instead of value. It initially renders with new lines but when you focus the textarea, it goes onto one line instead. Might not be much we can do about that but I'm not really concerned about it appearing on one line with a focused textarea.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

A bit disappointing, but oh well...

@cakegod cakegod requested a review from MaoShizhong September 4, 2024 19:30
Copy link
Contributor
@MaoShizhong MaoShizhong left a comment

Choose a reason for hiding this comment

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

Many thanks A09A for doing this!

@MaoShizhong MaoShizhong merged commit 7ff69d8 into TheOdinProject:main Sep 4, 2024
@cakegod cakegod deleted the issue_forms_yaml branch September 4, 2024 20:49
Oussama5379 added a commit to Oussama5379/javascript-exercises that referenced this pull request Feb 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refactor existing issue templates the new YAML issue template format
2 participants
0