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

Update CONTRIBUTING.md #82

Merged
merged 6 commits into from
Jul 17, 2024
Merged

Update CONTRIBUTING.md #82

merged 6 commits into from
Jul 17, 2024

Conversation

rcannood
Copy link
Contributor

@rcannood rcannood commented Jul 15, 2024

  • Extend the contributing guidelines (PR Update CONTRIBUTING.md #82):

    • Update format to Viash 0.9.

    • Descriptions should be formatted in markdown.

    • Add defaults to descriptions, not as a default of the argument.

    • Explain parameter expansion.

    • Mention that the contents of the output of components in tests should be checked.

Issue ticket number

Closes #xxxx

Checklist before requesting a review

  • I have performed a self-review of my code

  • Conforms to the Contributing guidelines

  • Proposed changes are described in the CHANGELOG.md

  • I have tested my code with viash ns test --parallel -q <name or namespace>

  • Check the correct box. Does this PR contain:

    • Breaking changes
    • New functionality
    • Major changes
    • Minor changes
    • Documentation
    • Bug fixes

@rcannood rcannood merged commit 8e9abad into main Jul 17, 2024
8 checks passed
@rcannood rcannood deleted the update-contributing-1 branch July 17, 2024 16:14
@rcannood rcannood mentioned this pull request Jul 17, 2024
10 tasks
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.

1 participant