search

theupdateframework / specification

The Update Framework specification
https://theupdateframework.github.io/specification/
Other
368 stars 54 forks source link

Create Issue Request and PR Template for Repository (tuf-specification) #307

Open shubhusion opened 4 months ago

shubhusion commented 4 months ago

Issue Description:

To standardize the process for submitting issues and pull requests (PRs) in the tuf-specification documentation repository. Currently, there's no consistent format for these requests, which can lead to confusion and inefficiency. By creating templates for both issues and PRs, we can ensure that all submissions include the necessary information and follow a standardized format, streamlining the review process and enhancing overall project organization.

Objective: Our goal is to create simple templates for submitting issues and PRs to the tuf-specification documentation repository. These templates will help ensure that all submissions include the necessary information and follow a standardized format, making it easier for new contributors to get involved.

Proposed Solution:

  1. Issue Request Template:

    • Title: Give your issue a brief but descriptive title.
    • Description: Tell us what's going on with the documentation. Include as much detail as possible, like what you expected to see versus what you're actually seeing.
    • Steps to Reproduce: If you can, please provide step-by-step instructions on how to reproduce the issue.
    • Expected Behavior: Describe what you expected to see in the documentation.
    • Actual Behavior: Describe what is currently represented in the documentation.
    • Additional Information: Anything else you think we should know, like screenshots or related issues.

  2. PR Template:

    • Title: Give your PR a brief but descriptive title.
    • Description: Let us know what changes you've made to the documentation in this PR. Keep it clear and concise.
    • Related Issue: If your PR addresses a specific issue, please link it here.
    • Checklist:
      • [ ] Updated the documentation
      • [ ] Reviewed the code
      • [ ] Updated the changelog
    • Code Snippet: If you've made changes to code in the documentation, include the updated code snippet(s) here.
    • Reviewers: @expert1 @expert2 @expert3
    • Additional Information: Anything else we should know before reviewing your PR.

Expected Outcome: With these templates in place, new contributors like you will have clear guidelines for submitting both issue requests and PRs related to the documentation. This will make it easier for you to get involved, improve the quality of submissions, and help us keep our documentation organized and up-to-date.

shubhusion commented 4 months ago

@lukpueh @trishankatdatadog @JustinCappos please review this issue also and please let me know if i can work on this as well.