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

Required Column added #462

Merged
merged 9 commits into from
Sep 20, 2022
Merged

Required Column added #462

merged 9 commits into from
Sep 20, 2022

Conversation

souravsk
Copy link
Contributor

Create the PR for this issue:-
Add information about optional/required fields in Actions documentation #380

@CLAassistant
Copy link

CLAassistant commented Sep 16, 2022

CLA assistant check
All committers have signed the CLA.

docs/actions.md Outdated Show resolved Hide resolved
docs/actions.md Outdated Show resolved Hide resolved
docs/actions.md Outdated Show resolved Hide resolved
docs/actions.md Outdated Show resolved Hide resolved
docs/actions.md Outdated Show resolved Hide resolved
docs/actions.md Outdated Show resolved Hide resolved
@simar7 simar7 self-requested a review September 16, 2022 22:47
Copy link
Member

@simar7 simar7 left a comment

Choose a reason for hiding this comment

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

thanks it looks awesome, just suggested a few changes.

docs/actions.md Outdated
*issuetype*| Optional: issue type, e.g., Bug |
*labels*| Optional: comma separated list of labels that will be assigned to ticket, e.g., ["label1", "label2"]|
*sprint*| Optional: Sprint name, e.g., "3.5 Sprint 8" |
Key | Description | Possible Values | Required
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Key | Description | Possible Values | Required
Key | Description | Supported Values | Required

Or

Suggested change
Key | Description | Possible Values | Required
Key | Description | Values | Required

@simar7 I think the word Possible is a little ambiguos. What do you think?

Copy link
Member

Choose a reason for hiding this comment

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

yeah your suggestion makes sense

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So which should I select

Copy link
Member

Choose a reason for hiding this comment

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

I'd leave it at Values.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

okay

docs/actions.md Outdated
*sprint*| Optional: Sprint name, e.g., "3.5 Sprint 8" |
Key | Description | Possible Values | Required
--------------|----------------------|-----------------|----------
*url* | Jira project url | | YES
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
*url* | Jira project url | | YES
*url* | Jira project url | | Yes

I think it's better use lowercase.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

okay @krol3
1:- "Yes"
2:- "yes"
which one will be good

Copy link
Member

Choose a reason for hiding this comment

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

I'd pick 1.

Copy link
Contributor

@krol3 krol3 left a comment

Choose a reason for hiding this comment

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

Thank you for your contribution @souravsk , a few comments below

Copy link
Member

@simar7 simar7 left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution.

@simar7 simar7 merged commit 1acba5a into aquasecurity:main Sep 20, 2022
@souravsk
Copy link
Contributor Author

Welcome @simar7 if any else I do please let me know

@simar7
Copy link
Member

simar7 commented Sep 21, 2022

Welcome @simar7 if any else I do please let me know

thanks @souravsk - I'm in the process of writing a design document that should highlight where we can improve Postee today. It's currently a PR in progress. I plan to create actionable issues from this document, that external contributors like you can pick up and work on. https://github.com/aquasecurity/postee/pull/466/files

@souravsk
Copy link
Contributor Author

it looks like it is already merged

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.

None yet

4 participants