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

Added templates #811

Merged
merged 5 commits into from
Apr 22, 2024
Merged

Conversation

AnonymousCodes911
Copy link
Contributor

fixes: #810
Added templates for :
-BUG issues
-Documentation Issues
-Generic Issues

Added templates for :
-BUG issues
-Documentation Issues
-Generic Issues
created a PR template
@matteobachetti
Copy link
Member

@AnonymousCodes911 would you like to explain what these templates do, how they work, etc?

Copy link

codecov bot commented Mar 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.43%. Comparing base (14756d9) to head (45456e3).

❗ Current head 45456e3 differs from pull request most recent head ffe2484. Consider uploading reports for the commit ffe2484 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #811      +/-   ##
==========================================
- Coverage   96.47%   96.43%   -0.05%     
==========================================
  Files          45       45              
  Lines        9135     9027     -108     
==========================================
- Hits         8813     8705     -108     
  Misses        322      322              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@AnonymousCodes911
Copy link
Contributor Author

Sure!, I thought it would be valuable to have a standardized process of creating issues on GitHub for different purposes related to Stingray.
Therefore I added 3 templates to cover most of the Issues that are generated here on Stingray;

General Issue: For miscellaneous issues.
Report a Bug: For Stingray bugs.
Improving Documentation: For documentation suggestions.

Each template will facilitate users in providing detailed information about their issues, making it easier to collaborate on solutions.

@matteobachetti
Copy link
Member

Ok, but how do they work? Are they automatically picked up by Github? Where can I find details on the syntax, and test the templates? Is there a specific documentation for it?

@AnonymousCodes911
Copy link
Contributor Author

Ok, but how do they work? Are they automatically picked up by Github?

Yes, ISSUE_TEMPLATES and PULL_REQUEST_TEMPLATE files are automatically recognized by GitHub. When they are a part of the .github folder of the repository, GitHub will display these templates as options when users create a new issue or pull request.

Where can I find details on the syntax, and test the templates? Is there a specific documentation for it?

You can refer to the following documentation pages:
Creating issue templates
Creating pull request templates

To test the templates

You can test the templates by creating new issues or pull requests in the repository. After doing so, you will be prompted with various templates, and you can choose them according to your requirements.

Copy link
Member

@matteobachetti matteobachetti left a comment

Choose a reason for hiding this comment

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

Thanks @AnonymousCodes911, this looks like a great addition to the Stingray repository, and I think we can merge it as-is, verify it works as it seems, and modify later. I would like the other mantainers to take a look as well, but for me looks good. I have just one question, please take a look.

.github/ISSUE_TEMPLATE/Issue.yml Outdated Show resolved Hide resolved
re-directed to the correct link
link-update
@AnonymousCodes911 AnonymousCodes911 marked this pull request as draft March 21, 2024 12:21
@AnonymousCodes911 AnonymousCodes911 marked this pull request as ready for review March 21, 2024 12:22
@matteobachetti matteobachetti added this pull request to the merge queue Apr 22, 2024
Merged via the queue into StingraySoftware:main with commit 9b8ab42 Apr 22, 2024
14 of 15 checks passed
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.

Implement Issue Templates and PR Templates
2 participants