ZeroIntensity / view.py

The Batteries-Detachable Web Framework
https://view.zintensity.dev
MIT License
205 stars 15 forks source link

Issue templates #27

Closed ZeroIntensity closed 11 months ago

ZeroIntensity commented 1 year ago

yeah

RP99 commented 11 months ago

Hi @ZeroIntensity,

If this is still open, I would like to contribute. Can you provide specifics for creating Issue Templates.

ZeroIntensity commented 11 months ago

Sure. We need three types of issue templates:

Feature/improvement requests should contain a section asking for a description describing what the request is and a section containing an example API for the feature. For example, a request for adding foo to view.bar could look like:

Description: This adds support for foo to bar

Example API:

view.bar.foo(...)

Next, I don't really know if this is possible with issue templates, but ideally, there should be some checkbox or button that adds the improvement or feature label depending on what the user added. The request label should also be added.

Assuming the checkbox/button thing from above is possible for bug reports, we want a way to differentiate crashes (e.g. segmentation faults) from bugs (incorrect behavior, error thrown, etc.). Then, provide a section for the full traceback/console output.

Finally, for questions, not much is needed just make sure to have some sort of thing saying "have you asked in our discord server"

RP99 commented 11 months ago

@ZeroIntensity check this ~ Question template form and let me know if this ok or whether I need to make any changes before committing to main.

RP99 commented 11 months ago

Next, I don't really know if this is possible with issue templates, but ideally, there should be some checkbox or button that adds the improvement or feature label depending on what the user added. The request label should also be added. Assuming the checkbox/button thing from above is possible for bug reports, we want a way to differentiate crashes (e.g. segmentation faults) from bugs (incorrect behavior, error thrown, etc.). Then, provide a section for the full traceback/console output.

@ZeroIntensity Also, above dynamic issue templates creation requirement can't be created and is giving unexpected results. So, should I create separate issue templates say Bug_Report and Crash_Report?

ZeroIntensity commented 11 months ago

Go for it.

RP99 commented 11 months ago

Go for it.

This is in regards to: First Comment ??

@ZeroIntensity check this ~ Question template form and let me know if this ok or whether I need to make any changes before committing to main.

OR

Second Comment??

Next, I don't really know if this is possible with issue templates, but ideally, there should be some checkbox or button that adds the improvement or feature label depending on what the user added. The request label should also be added. Assuming the checkbox/button thing from above is possible for bug reports, we want a way to differentiate crashes (e.g. segmentation faults) from bugs (incorrect behavior, error thrown, etc.). Then, provide a section for the full traceback/console output.

@ZeroIntensity Also, above dynamic issue templates creation requirement can't be created and is giving unexpected results. So, should I create separate issue templates say Bug_Report and Crash_Report?

ZeroIntensity commented 11 months ago

Oh, I didn't see the first one, my bad. I was talking about the second one. For the first one, it looks great.

RP99 commented 11 months ago

Next, I don't really know if this is possible with issue templates, but ideally, there should be some checkbox or button that adds the improvement or feature label depending on what the user added. The request label should also be added. Assuming the checkbox/button thing from above is possible for bug reports, we want a way to differentiate crashes (e.g. segmentation faults) from bugs (incorrect behavior, error thrown, etc.). Then, provide a section for the full traceback/console output.

@ZeroIntensity Also, above dynamic issue templates creation requirement can't be created and is giving unexpected results. So, should I create separate issue templates say Bug_Report and Crash_Report?

So, I have created separated templates. But, there seems to be no label for crash. Hence, I had to create a new label as crash

ZeroIntensity commented 11 months ago

Huh? There is a crash label, see #38

RP99 commented 11 months ago

Oh! I can see only 10 labels (no crash present) in forked project as opposed to 17 in main. How do I sync it?

ZeroIntensity commented 11 months ago

Not sure, I can always fix it before it gets merged

RP99 commented 11 months ago

I will work on Feature and Bug Request issue template forms tomorrow (separate like Bug and Crash reports). Signing off for now.