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

document dev:true in configs, and high level dev documentation #136

Open
breezykermo opened this issue Feb 15, 2020 · 1 comment
Open

document dev:true in configs, and high level dev documentation #136

breezykermo opened this issue Feb 15, 2020 · 1 comment
Assignees
Labels
enhancement New feature or request help wanted Open for community contribution! Be sure to comment on the issue to check status

Comments

@breezykermo
Copy link
Member

For development, setting this flag to true will bypass mtriage's error handling mechanisms so that you can see what's buggy about your selector or analyser.

This should probably come along with a document that explains at a high level all the things you need to know about developing new components, such as the lifecycle API.

@breezykermo breezykermo added the release Currently in progress for next release label Feb 15, 2020
@breezykermo breezykermo self-assigned this Feb 15, 2020
@breezykermo
Copy link
Member Author

The fix for this can also include some scaffolding functionality for new selectors and analysers:

  • ./mtriage dev new selector
  • ./mtriage dev new analyser

Both should create empty components with comments explaining the parts of the lifecycle. This could serve as an effective substitute for more extensive documentation on how to create custom components.

This was referenced Mar 16, 2020
@breezykermo breezykermo added enhancement New feature or request help wanted Open for community contribution! Be sure to comment on the issue to check status and removed release Currently in progress for next release labels Nov 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Open for community contribution! Be sure to comment on the issue to check status
Projects
None yet
Development

No branches or pull requests

1 participant