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

📚 Add Documentation Enhancement Issue Template #474

Merged
merged 2 commits into from
Oct 23, 2024

Conversation

KesharwaniArpita
Copy link
Contributor

Contributor checklist


Description

This PR introduces a new issue template to help contributors suggest improvements or updates to the documentation of Scribe-Data. The template ensures that contributors provide clear and structured feedback on existing documentation, making it easier for maintainers to assess and implement improvements.


Changes Made:

  • Added a new issue template for Documentation Enhancement under the .github/ISSUE_TEMPLATE/ directory.
  • Template name: 📚 Documentation Enhancement
  • Includes a checkbox section for contributors to confirm they have:
    • Searched existing open documentation issues.
    • Agreed to follow the project's Code of Conduct.
  • Textareas for contributors to describe:
    • Current Documentation: Link or description of the documentation to be enhanced.
    • Suggested Enhancements: Detailed suggestions for improvement.
    • Benefit: Optional field to explain how the suggested changes will benefit the community or the project.
  • Markdown block thanking contributors for their feedback.

Purpose:

The new template is designed to streamline the process of proposing documentation improvements, making it easier for maintainers to gather relevant information. It encourages contributors to provide well-structured suggestions while acknowledging the community guidelines.


How to Test:

  1. Navigate to the New Issue page.
  2. Select the Documentation Enhancement template.
  3. Fill in the required fields to suggest documentation improvements.

Additional Notes:

  • This template aligns with Scribe-Data's current issue structure and processes.
  • Maintainers and contributors can continue refining the template as needed based on feedback.

This PR enhances the contribution process by providing a structured approach to documentation improvements, benefiting both maintainers and the broader community.

Copy link

github-actions bot commented Oct 23, 2024

Thank you for the pull request!

The Scribe team will do our best to address your contribution as soon as we can. The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

If you're not already a member of our public Matrix community, please consider joining! We'd suggest using Element as your Matrix client, and definitely join the General and Data rooms once you're in. Also consider joining our bi-weekly Saturday dev syncs. It'd be great to have you!

Maintainer checklist

  • The linting and formatting workflow within the PR checks do not indicate new errors in the files changed

  • The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

Copy link
Member

@andrewtavis andrewtavis left a comment

Choose a reason for hiding this comment

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

This is a really nice idea, @KesharwaniArpita :) Thanks for sending it along! I switched the emoji as I normally follow gitmoji for all things emojis in projects. Also removed the third text area as this info can likely just go in the second 😊

@andrewtavis andrewtavis merged commit 703f70b into scribe-org:main Oct 23, 2024
5 of 6 checks passed
@andrewtavis andrewtavis added the hacktoberfest-accepted Accepted as a part of Hacktoberfest label Oct 23, 2024
@KesharwaniArpita
Copy link
Contributor Author

Thanks @andrewtavis

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest-accepted Accepted as a part of Hacktoberfest
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants