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

docs: add layer styleguide #447

Merged

Conversation

amstewart
Copy link
Contributor

Add a first draft of a meta-nilrt layer styleguide, to coordinate syntax
and styling.

Signed-off-by: Alex Stewart [email protected]

This styleguide includes some existing style sections from the nilrt.git CONTRIBUTING guide. I'll submit a PR to remove it from that document.

docs/styleguide.md Outdated Show resolved Hide resolved
@amstewart amstewart force-pushed the dev/hardknott/styleguide branch from 5541431 to fc8dc83 Compare August 17, 2022 18:14
@amstewart
Copy link
Contributor Author

Patch V2

@amstewart amstewart requested a review from bstreiff August 19, 2022 19:13
Copy link
Contributor

@bstreiff bstreiff left a comment

Choose a reason for hiding this comment

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

"accomidate upstreames" could use a spellcheck pass but I assume you'll probably squash that into the other commit.

docs/styleguide.md Show resolved Hide resolved
docs/styleguide.md Show resolved Hide resolved
Add a first draft of a meta-nilrt layer styleguide, to coordinate syntax
and styling.

Signed-off-by: Alex Stewart <[email protected]>
Not all upstream projects have "mailing lists", and sections of the
styleguide which reference linking to the upstream list might be
confusing to developers.

Make it clear that the upstream link can refer to a merge PR as well.

Signed-off-by: Alex Stewart <[email protected]>
@amstewart amstewart force-pushed the dev/hardknott/styleguide branch from fc8dc83 to e0d7b17 Compare August 23, 2022 20:35
@amstewart
Copy link
Contributor Author

amstewart commented Aug 23, 2022

Patch V3

  • Audited the commit messages and styleguide body for spelling and grammar.

amstewart added a commit to ni/nilrt that referenced this pull request Aug 23, 2022
The styleguide information from the nilrt.git CONTRIBUTING document has
been copied into the meta-nilrt.git:docs/styleguide.md doc, in
meta-nilrt [#447](ni/meta-nilrt#447).

Remove it from the CONTRIBUTING doc.

Signed-off-by: Alex Stewart <[email protected]>
@amstewart amstewart merged commit 4b80d19 into ni:nilrt/master/hardknott Sep 23, 2022
@amstewart amstewart deleted the dev/hardknott/styleguide branch September 23, 2022 16:29
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.

3 participants