Skip to content

NH-116007: update contributing and config doc#221

Merged
xuan-cao-swi merged 12 commits into
mainfrom
NH-116007
Sep 24, 2025
Merged

NH-116007: update contributing and config doc#221
xuan-cao-swi merged 12 commits into
mainfrom
NH-116007

Conversation

@xuan-cao-swi
Copy link
Copy Markdown
Contributor

Description

Test (if applicable)

@xuan-cao-swi xuan-cao-swi marked this pull request as ready for review September 19, 2025 16:44
@xuan-cao-swi xuan-cao-swi requested a review from a team as a code owner September 19, 2025 16:44
Comment thread CONFIGURATION.md Outdated
Comment thread CONFIGURATION.md
Comment thread CONFIGURATION.md
Copy link
Copy Markdown
Contributor

@tammy-baylis-swi tammy-baylis-swi left a comment

Choose a reason for hiding this comment

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

Lgtm, it's definitely easier to read! I had some suggestions you can take or leave

Comment thread CONFIGURATION.md Outdated
Copy link
Copy Markdown
Contributor

@cheempz cheempz left a comment

Choose a reason for hiding this comment

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

Wow, big revamp :) The thing i actually had in mind for this Jira task was actually much smaller task--now that it's pure Ruby, was thinking the CONTRIBUTING doc could be revamped so that dev workflow does not need to be in a container. Yes, to run the regression tests it would still spin up containers, but simply to make a change, run a specific test case, and do a local build should be achievable directly on MacOS now, correct?

@xuan-cao-swi
Copy link
Copy Markdown
Contributor Author

now that it's pure Ruby, was thinking the CONTRIBUTING doc could be revamped so that dev workflow does not need to be in a container.

Oh right, yes, everything can run without container (although I still prefer container so it can enforce env isolation). I can add the additional context about running in host machine.

Copy link
Copy Markdown
Contributor

@cheempz cheempz left a comment

Choose a reason for hiding this comment

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

Thanks @xuan-cao-swi . i left a bunch of suggestions for the CONFIGURATION page, it's a nice revamp but i do feel AI assisted content gets kind of verbose and we still need to check for correctness.

Comment thread CONFIGURATION.md Outdated
Comment thread CONFIGURATION.md Outdated
Comment thread CONFIGURATION.md Outdated
Comment thread CONFIGURATION.md Outdated
Comment thread CONFIGURATION.md Outdated
Comment thread CONFIGURATION.md Outdated
Comment thread CONFIGURATION.md Outdated
Comment thread CONFIGURATION.md Outdated
Comment thread CONFIGURATION.md Outdated
Comment thread CONFIGURATION.md Outdated
Comment thread CONTRIBUTING.md Outdated
Copy link
Copy Markdown
Contributor

@cheempz cheempz left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for the revisit!

@xuan-cao-swi xuan-cao-swi merged commit 238f50d into main Sep 24, 2025
14 checks passed
@xuan-cao-swi xuan-cao-swi deleted the NH-116007 branch September 24, 2025 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants