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

Recommendation: outline desired contributions in README and Issues #1

Open
opattison opened this issue Feb 17, 2014 · 2 comments
Open

Comments

@opattison
Copy link
Contributor

Lay out a framework for exactly what sort of help is needed. Moving some of the front matter from the initial principles document into a README is a good first step, but also creating any issues for further desired content would be useful.

An example Issue might be 'develop a list of examples of independent projects' and then determine what sort of form that might take so that potential contributors know what fits for the project. Whether or not that particular issue is is a good idea might be better figured out in the Issues section rather than in a PR.

Of course, any kind of comment or improvement is good, but what does a great one look like? (Maybe too early to tell, eh? But worth outlining soon, perhaps.) I personally like Github issues that are small and manageable in scope. Any other thoughts on how else you'd like to see Issues work?

@equivalentideas
Copy link
Owner

Really good ideas, I'll try and work in the issues for stuff I can envision being added.

Do you think that list should be part of the README or in a new file?

I really like Issues too. I'm enjoying following the alistapart threads. I'm not sure what the best way to label them etc. . I'll do some reading on it and report back.

I'd like to make this very inclusive for non-githubers, and also make it an easy starting point for people who want to learn it. Including example issues and commits is a great idea.

@opattison
Copy link
Contributor Author

I'll at least include my sample issue as an open issue, since it's the kind of thing that would be valuable as a draft addendum to the principles document, if not in the longer term as part of the document itself.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants