Skip to content

Improve contributing guidelines #269

Closed

Description

@pffijt

The current contributing guidelines describes 3 steps that are quite minimal. We should add additional steps, and maybe we should create a separate contributing.md for better github integration https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.

I think the following steps should be atleast added:

  • Class pydoc with usage example with the addition of a new container/module
  • Integrate module with sphinx

Activity

  1. tillahoffmann commented on Jan 6, 2023

    @tillahoffmann
    Contributor

    I've updated the guidelines as part of #290 to address #288. Will close for now, but happy to discuss further changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions