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]: added Issue and PR templates to help docs contributors #47

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

goodylili
Copy link

Please see my fork to verify everything works.

Create an issue and make an example PR

On merge, this would be the last freestyle PR, and issues would be as descriptive as ever.

Here's the PR template in the last commit

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Link to issue

Please add a link to any relevant issues/tickets.

Type of Documentation Change

  • Bug fix (correcting errors or inaccuracies in existing documentation)
  • New content (adding new documentation sections or topics)
  • Update (revising existing documentation for clarity or completeness)
  • Restructure (reorganizing documentation without changing core content)
  • Breaking change (major revision that impacts how users navigate or understand documentation)
  • Translation needed
  • Technical review required
  • Screenshots/images need updating

Please delete options that are not relevant.

Quick Checks

  • I've ran Mintlify locally to verify that everything works.
  • By making this PR, I permit Abstract to use my code.

Additional Information (if applicable)

@goodylili
Copy link
Author

Hi @jarrodwatts @0xabril

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.

1 participant