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

📝 Adding a new GitHub issue template for docs changes #2300

Merged
merged 3 commits into from
Oct 8, 2024

Conversation

isaaclombardssw
Copy link
Contributor

@isaaclombardssw isaaclombardssw commented Oct 7, 2024

This pull request introduces a new issue template specifically for proposing changes to the official documentation. The template aims to streamline the process of suggesting and discussing documentation updates.

New issue template for documentation changes:

  • .github/ISSUE_TEMPLATE/docs-update.md: Added a new template to propose content changes to the official Tina.io documentation. This template includes sections for describing the current issue, outlining the proposed changes, listing tasks, providing additional context, and adding relevant screenshots.

I very often create PBIs for this kind of stuff and it would save me time 🙏

General Contributing:

All New Content Submissions: (To be confirmed by reviewer)

  • Title is short & specific
  • Headers are logically ordered & consistent
  • Purpose of document is explained in the first paragraph
  • Procedures are tested and work
  • Any technical concepts are explained or linked to
  • Document follows structure from templates
  • All links work
  • The spelling and grammar checker has been run
  • Graphics and images are clear and useful
  • Any prerequisites and next steps are defined.

Copy link

vercel bot commented Oct 7, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
tina-io ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 8, 2024 4:14am

@isaaclombardssw isaaclombardssw marked this pull request as ready for review October 7, 2024 23:12
@isaaclombardssw isaaclombardssw requested a review from a team as a code owner October 7, 2024 23:12
@Marxoz Marxoz changed the title 📝 – Adding a new GitHub issue template for docs changes 📝 Adding a new GitHub issue template for docs changes Oct 8, 2024
@CLAassistant
Copy link

CLAassistant commented Oct 8, 2024

CLA assistant check
All committers have signed the CLA.

@isaaclombardssw isaaclombardssw merged commit dbcb54c into main Oct 8, 2024
3 of 4 checks passed
@isaaclombardssw isaaclombardssw deleted the new-docs-issue-template branch October 8, 2024 04:19
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.

3 participants