glossary
glossary copied to clipboard
Feedback, and suggested improvements, regarding contributing to this repo
Term issue
Feedback on this repo:
- When you create an issue, it only gives you the option to update existing terms or create new ones. Neither of those scenarios were right for this issue.
- The
contributing.md
file suggests that you create an issue by clicking the "Give us feedback" link on the page. I don't see that on the glossary page anywhere. - In
contributing.md
we should instruct users which branch to use for branching off of and pushing to (develop
). - We should tell them to edit the terms in the
_converted
directory, not theterms
directory (though I hearterms
may be removed soon anyway). - In the
contributing.md
thereadMore
attribute is included in the key-value pair table but not in the sample. Could be useful to see that. - The PR descrip form doesn’t comment out the instructions. Didn’t know if you wanted those to appear in every finished PR descrip.
- There is no default reviewer. Will contributors know to ask James to review it? We should consider that.
Terms and definitions
Term:
What's wrong:
- [ ] Incorrect definition
- [ ] Incorrect related links
- [ ] Incorrect tagging
- [ ] Other (please specify)
Additional information/resources
Hi @vinayshah. Thank you for your report. To help us process this issue please make sure that you provided the following information:
- [ ] Summary of the issue
- [ ] Information on your environment
- [ ] Steps to reproduce
- [ ] Expected and actual results
Please make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, please, add a comment to the issue:
@magento-engcom-team give me 2.3-develop instance
- upcoming 2.3.x release
For more details, please, review the Magento Contributor Assistant documentation.
@vinayshah do you confirm that you were able to reproduce the issue on vanilla Magento instance following steps to reproduce?
- [ ] yes
- [ ] no
- Join Magento Community Engineering Slack and ask your questions in #github channel.
Hi @AlexWorking. Thank you for working on this issue. In order to make sure that issue has enough information and ready for development, please read and check the following instruction: :point_down:
-
[ ] 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
Details
If the issue has a valid description, the labelIssue: Format is valid
will be added to the issue automatically. Please, edit issue description if needed, until labelIssue: Format is valid
appears. -
[ ] 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add
Issue: Clear Description
label to the issue by yourself. -
[ ] 3. Add
Component: XXXXX
label(s) to the ticket, indicating the components it may be related to. -
[ ] 4. Verify that the issue is reproducible on
2.3-develop
branchDetails
- Add the comment@magento-engcom-team give me 2.3-develop instance
to deploy test instance on Magento infrastructure.
- If the issue is reproducible on2.3-develop
branch, please, add the labelReproduced on 2.3.x
.
- If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
-
[ ] 5. Verify that the issue is reproducible on
2.2-develop
branch.Details
- Add the comment@magento-engcom-team give me 2.2-develop instance
to deploy test instance on Magento infrastructure.
- If the issue is reproducible on2.2-develop
branch, please add the labelReproduced on 2.2.x
-
[ ] 6. Add label
Issue: Confirmed
once verification is complete. -
[ ] 7. Make sure that automatic system confirms that report has been added to the backlog.
Hi @vinayshah. Thank you for working on this issue. In order to make sure that issue has enough information and ready for development, please read and check the following instruction: :point_down:
-
[ ] 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
Details
If the issue has a valid description, the labelIssue: Format is valid
will be added to the issue automatically. Please, edit issue description if needed, until labelIssue: Format is valid
appears. -
[ ] 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add
Issue: Clear Description
label to the issue by yourself. -
[ ] 3. Add
Component: XXXXX
label(s) to the ticket, indicating the components it may be related to. -
[ ] 4. Verify that the issue is reproducible on
2.3-develop
branchDetails
- Add the comment@magento-engcom-team give me 2.3-develop instance
to deploy test instance on Magento infrastructure.
- If the issue is reproducible on2.3-develop
branch, please, add the labelReproduced on 2.3.x
.
- If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
- [ ] 5. Verify that the issue is reproducible on
2.2-develop
branch.Details
- Add the comment@magento-engcom-team give me 2.2-develop instance
to deploy test instance on Magento infrastructure.
- If the issue is reproducible on2.2-develop
branch, please add the labelReproduced on 2.2.x
- Join Magento Community Engineering Slack and ask your questions in #github channel.
Hello @vinayshah
Thank you for feedback and your proposal!
Based on the description and label feature request
the issue has been transferred to Magento Feature Request public repo.
any update on this?