镜像站点 · 本页由第三方 GitHub 只读镜像提供,非 GitHub 官方站点,不接受任何登录或凭据输入。前往 github.com
Skip to content

Add CONTRIBUTING.md #185

Open
Open

Description

@stuaxo

CONTRIBUTING.md and possibly an issue template could be good.

I had a really brief look at a few and most are much longer than needed for a project with this few contributors - the best way might be to look at examples from other projects then write our own based on the bits we like.

To start with we can collect examples here that we like.

A lot of things in other CONTRIBUTING.md probably aren't needed on this project (yet), just because of the small amount of developers. The document should aim to streamline getting new developers started.

Activity

  1. stuaxo commented on Jan 19, 2023

    @stuaxo
    Author

    Example: The Atom contributing.md has some good sections and I like that they surfaced "I don't want to read this whole thing, I just have a question!!!"

    https://github.com/atom/atom/blob/master/CONTRIBUTING.md

  2. kaixiong commented on Jan 20, 2023

    @kaixiong
    Member

    Yes we should do this. There is actually a hastily written wiki page titled Hacking Guide which we can source from.

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions