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 guide to maintaining a quality crate. #249

Closed
alilleybrinker opened this issue Jan 16, 2016 · 5 comments
Closed

Add guide to maintaining a quality crate. #249

alilleybrinker opened this issue Jan 16, 2016 · 5 comments

Comments

@alilleybrinker
Copy link

There's a lot to handle when taking on the leadership of a package for the Rust ecosystem. It may be worthwhile to write a guide to the creation and maintenance of an active, high-quality crate.

The guide could cover topics like:

  • Handling versioning, including proper practice for Semver, and making sure to tag versions in git and push them to GitHub (or whatever you're using for code hosting, if it's not GitHub).
  • Having and enforcing a code of conduct.
  • Setting up continuous integration.
  • Making your project welcoming to newcomers.

Thoughts?

@alexcrichton
Copy link
Member

Sounds like a plausible idea to me!

cc @steveklabnik

@alilleybrinker
Copy link
Author

If it's alright then, I am going to get started on some draft ideas. Obviously, this will be something to get in touch with crate maintainers about, to solicit input from people with experience. I'll keep you all posted.

@steveklabnik
Copy link
Member

I'm also interested in being kept in the loop here, for sure.

@steveklabnik
Copy link
Member

(It's worth knowing that doc.crates.io is actually in the Cargo repo)

@alilleybrinker
Copy link
Author

Thanks! I'll go ahead and open an issue over there then.

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

3 participants