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

rust-bio docathon 2020 #276

Open
tedil opened this issue Jun 29, 2020 · 0 comments
Open

rust-bio docathon 2020 #276

tedil opened this issue Jun 29, 2020 · 0 comments

Comments

@tedil
Copy link
Member

tedil commented Jun 29, 2020

To improve the usability of rust-bio and speed up development based on the library, we'll host a docathon next Tuesday, July 7th 2020. We'll be starting at 10am German time (UTC+02:00) and will be online until 6pm, but feel free to join at any time during the day -- and if someone wants to carry on later in the day (or across into another time zone): the more docs, the better!

For any questions, to coordinate and to have a little chat, hop on to our rust-bio docathon Discord server!

Getting started

Before you start, check out the contribution guidelines. For example, you might want to officially join the rust-bio team to be able to create branches off the main repository. And for actually improving the docs, have a look at the brand new documentation guidelines.

To track where improvements are needed most and who is tackling what, we have created a project board. Feel free to add notes under To do for whatever you think is lacking documentation:
https://github.com/rust-bio/rust-bio/projects/1

From that project board, choose one of the issues, move it to In progress and assign yourself. Once you're done with adding the documentation, open a pull request and request a review from one of the other docathoners. Once the pull request is merged, simply close the issue -- the project board should automagically 🧙🏽‍♀️ move it to Done.

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