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

feat: add issue template for docs #24

Merged

Conversation

CBID2
Copy link
Contributor

@CBID2 CBID2 commented Oct 4, 2023

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

Description

This PR adds an issue template for documentation.

Fixes Issue

Closes #5

Acceptance Criteria

  • in the .github folder create a folder called ISSUE_TEMPLATE
  • in the folder ISSUE_TEMPLATE create a file called docs.yml
  • for the name use: πŸ“„ Documentation issue
  • for the description use: Found an issue in the documentation? You can use this one!
  • for the labels use: ["πŸ“„ aspect: text"]
  • in the body, add three type textarea
  • each of these textarea has an unique id, description, screenshots and extrainfo
  • each type has 2 attributes: a label and a description. Come up with own text. Hint look in other repositories which uses issue templates to get inspiration what to write
  • each type has a validations, set to true for the description and false to screenshots and extrainfo

Type of Changes

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
πŸ› Bug fix
X ✨ New feature
πŸ”¨ Refactoring
πŸ’― Add tests
πŸ”— Update dependencies
πŸ“œ Docs

Updates

Before

After

Testing Steps / QA Criteria

@netlify
Copy link

netlify bot commented Oct 4, 2023

βœ… Deploy Preview for accessibility-mentor ready!

Name Link
πŸ”¨ Latest commit 08fbb36
πŸ” Latest deploy log https://app.netlify.com/sites/accessibility-mentor/deploys/651dc951dd9c7700085b3e13
😎 Deploy Preview https://deploy-preview-24--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: 97
Best Practices: 100
SEO: 83
PWA: -
View the detailed breakdown and full score reports

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

@CBID2 CBID2 mentioned this pull request Oct 4, 2023
9 tasks
@YuriDevAT YuriDevAT added the hacktoberfest-accepted Hacktoberfest contribution label Oct 6, 2023
@YuriDevAT
Copy link
Member

Well done @CBID2 πŸ‘πŸ½ Thanks for contributing to the project.

@YuriDevAT YuriDevAT merged commit 31b3122 into YurisCodingClub:main Oct 6, 2023
4 checks passed
@CBID2 CBID2 deleted the adding-issue-template-for-docs branch October 6, 2023 05:22
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.

[FEATURE] Issue template docs
2 participants