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

Recommendations for the "non-technical" stuff (license, contributing, code of conduct, etc) #8

Open
nastevens opened this issue Apr 2, 2018 · 2 comments

Comments

@nastevens
Copy link

nastevens commented Apr 2, 2018

Assuming that open source projects are going to be a large target of the crate-ci effort, it would be extremely useful to me if there was an easy checklist of the "non-technical" stuff that is useful in an repo. The following is a non-exhaustive list of things that fit into that category:

  • License information
    • A template for a "default", i.e. Apache-2.0/MIT, would be useful
  • Contributing guidelines
    • A template here modeled after Rust's own guidelines would be useful
  • Project code of conduct
    • Template again off of Rust's CoC
  • Templates for submitting issues, if appropriate
  • Important Cargo.toml keywords

Like I said, this is not meant to be exhaustive but to drive discussion if these things are useful and if so, what to cover.

@epage
Copy link
Contributor

epage commented Apr 2, 2018

I could see documenting some of these things here just as a place to do it but I assume there will be a set of maintainership guidelines that are going to be created to be a home for these.

Templates for submitting issues, if appropriate

Since this project is about streamlining maintenance, Issue and PR templates would make definitely be in scope.

@epage
Copy link
Contributor

epage commented Mar 1, 2019

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