Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC: Tighten up first-time contributor suggestion on README.md and dev.index.rst #19778

Closed
@mattip

Description

@mattip

Both of these sources state

If you’re unsure where to start or how your skills fit in, reach out! You can ask on the mailing list or here, on GitHub, by opening a new issue or leaving a comment on a relevant issue that is already open.

I think the last bit is leading to comments on the issues "I am new, can I work on this?". We should clarify what we mean here: do we really want these kinds of comments? Perhaps we need a top-level "new contributor" walkthrough like

Code fix?

  • build numpy locally or on gitpod
  • change an existing test that exersizes the code path for the issue (or, unlikely, add a new test), make sure it fails
  • fix the issue
  • make sure the test passes
  • submit a PR linking to the issue (fixes gh-XXXX).

Documentation fix?

  • make sure the documentation still builds correctly
  • spell checker?

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions