Skip to content

contributing.md needs an update #2528

Closed
@nagledb

Description

The doc states "There is no issue template" but there actually is an issue template and #2504 will add a PR template as well.

#2504 also includes a checklist for PRs, but none of the items listed are documented in contributing.md:

  • My code follows the project code style
  • I have written test for my code and it has been tested
  • All existing tests have been passed
  • I have attached a screenshot/video to visualize my change if possible

I recommend linking to docs/build.md and docs/debug.md.

I recommend giving the steps to run the test suite either in contributing.md or build.md. (It's easy to figure out how to run them, but documenting it may better encourage people to actually run them.)

I recommend explaining what is meant by "project code style". Do you just want us to try to match the style of existing code as best we can? Or are you using a code style that's documented somewhere? If there's tooling to verify compliance with code style, documenting how to run it would also be great.

Metadata

Assignees

No one assigned

    Labels

    improvement request 🔨Issue concerns an existing feature that needs improvement.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions