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

Add naming conventions for project name #290

Merged
merged 3 commits into from
Mar 28, 2023
Merged

Conversation

viniciusdc
Copy link
Contributor

@viniciusdc viniciusdc commented Mar 21, 2023

Reference Issues or PRs

closes #103

What does this implement/fix?

Put a x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds a feature)
  • Breaking change (fix or feature that would cause existing features not to work as expected)
  • Documentation Update
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • Other (please describe):

Testing

  • Did you test the pull request locally?
  • Did you add new tests?

Documentation

Access-centered content checklist

Text styling

  • The content is written with plain language (where relevant).
  • If there are headers, they use the proper header tags (with only one level-one header: H1 or # in markdown).
  • All links describe where they link to (for example, check the Nebari website).
  • This content adheres to the Nebari style guides.

Non-text content

  • All content is represented as text (for example, images need alt text, and videos need captions or descriptive transcripts).
  • If there are emojis, there are not more than three in a row.
  • Don't use flashing GIFs or videos.
  • If the content were to be read as plain text, it still makes sense, and no information is missing.

Any other comments?

@netlify
Copy link

netlify bot commented Mar 21, 2023

Deploy Preview for nebari-docs ready!

Name Link
🔨 Latest commit bf60198
🔍 Latest deploy log https://app.netlify.com/sites/nebari-docs/deploys/6422d397331efb00085e3fbc
😎 Deploy Preview https://deploy-preview-290--nebari-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@viniciusdc viniciusdc added the needs: review 👀 This PR is complete and ready for reviewing label Mar 21, 2023
@viniciusdc
Copy link
Contributor Author

Source for naming conventions described in this PR nebari-dev/nebari#1257

Copy link
Member

@pavithraes pavithraes left a comment

Choose a reason for hiding this comment

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

Thanks, Vini! I've merged some small updates for consistency. :)

@pavithraes pavithraes added status: approved 💪🏾 This PR has been reviewed and approved for merge and removed needs: review 👀 This PR is complete and ready for reviewing labels Mar 28, 2023
@pavithraes pavithraes merged commit 8b1e4d5 into main Mar 28, 2023
@pavithraes pavithraes deleted the vini/naming-conventions-103 branch March 28, 2023 11:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] - Add notes on project naming conventions
2 participants