Skip to content

Collaborate and document best practices for GH actions, automated testing, etc. #899

@sierra-moxon

Description

@sierra-moxon

@turbomam @sujaypatil96 @jfy133 - would you all be interested in working on a style guide with me for the software stacks and control mechanisms we use to maintain this repository?

This PR is great: #898 in adding linting to our automated actions! I want to document the best practices used here as a first step.

Some possible discussion topics:

  • Do we favor Make, GH actions, poetry/python control mechanisms to trigger continuous integration checks.
  • Where are the boundaries that we can provide to new developers in terms of the distribution of tasks between these mechanisms? e.g. should we use bash code within GH actions when we need to extend an existing task? Or do we use a script in the repo itself?
  • Where do automated tests (in python) fit in?
  • How does development proceed locally to test things automated in GH Actions before we open PRs?

I'm sure there are other topics :).

I can share a couple of resources in other projects, but happy for other ones to review as well:

  1. best practices/style that our group uses in other repos (this is an evolving standard b/c software always evolves but it gives us a place to start): https://berkeleybop.github.io/best_practice/
  2. LinkML cookiecutter (has its own issues/challenges but sets up a boilerplate with some handy conventions): https://github.com/linkml/linkml-project-cookiecutter

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions