Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CONTRIBUTING.md #185

Open
stuaxo opened this issue Jan 19, 2023 · 2 comments
Open

Add CONTRIBUTING.md #185

stuaxo opened this issue Jan 19, 2023 · 2 comments

Comments

@stuaxo
Copy link

stuaxo commented Jan 19, 2023

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.

@stuaxo
Copy link
Author

stuaxo commented Jan 19, 2023

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

@kaixiong
Copy link
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
Projects
None yet
Development

No branches or pull requests

2 participants