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

fix: revise the format of doc.yml file #58

Merged
merged 8 commits into from Oct 27, 2023

Conversation

CBID2
Copy link
Contributor

@CBID2 CBID2 commented Oct 26, 2023

For an example of how to fill this template out, see this Pull Request in the Wiki.

Description

This PR fixes the formatting in the docs.yml file in the Issue Template folder.

Fixes Issue

Closes #51

Acceptance Criteria

  • Update the content of the docs.yml file
  • if uncertain, compare with the two yml files which are working (bug.yml, other.yml)

Type of Changes

This PR makes the following changes:

  • Adds more descriptive name and description
  • Adds descriptive labels and a checklist
  • Adds a section for contributors to describe their proposed solution and how it can benefit the project

Make sure your code follows the code style of this project.
Make sure your code is up2date.
The title of the PR is the same as the title of the issue.

Type
x πŸ› Bug fix
✨ New feature
πŸ”¨ Refactoring
πŸ’― Add tests
πŸ”— Update dependencies
πŸ“œ Docs

Updates

Before

before

After

improved issue template

Testing Steps / QA Criteria

Check for Preview

@netlify
Copy link

netlify bot commented Oct 26, 2023

βœ… Deploy Preview for accessibility-mentor ready!

Name Link
πŸ”¨ Latest commit 16f155e
πŸ” Latest deploy log https://app.netlify.com/sites/accessibility-mentor/deploys/653aa66e76616f0008cd29a7
😎 Deploy Preview https://deploy-preview-58--accessibility-mentor.netlify.app
πŸ“± Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 100
Accessibility: 100
Best Practices: 100
SEO: 92
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@CBID2
Copy link
Contributor Author

CBID2 commented Oct 26, 2023

Hi @YuriDevAT. Here's a new version of my PR. I think it would be best to merge this one first before the feature.yml one.

@CBID2
Copy link
Contributor Author

CBID2 commented Oct 26, 2023

Hi @YuriDevAT! :) I managed to do the PR. Can you merge this one first before I do the one for issue #52? It'll lessen the chance of merge conflicts.

@YuriDevAT
Copy link
Member

Perfect, well done πŸ₯³

@YuriDevAT YuriDevAT added the hacktoberfest-accepted Hacktoberfest contribution label Oct 27, 2023
@YuriDevAT YuriDevAT merged commit 541ff4b into YurisCodingClub:main Oct 27, 2023
4 of 5 checks passed
@CBID2 CBID2 deleted the revise-docs.yml-file branch October 27, 2023 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest-accepted Hacktoberfest contribution
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] issue template DOCS does not appear
2 participants