Skip to content

Latest commit

 

History

History
51 lines (28 loc) · 4.57 KB

CONTRIBUTING.md

File metadata and controls

51 lines (28 loc) · 4.57 KB

Contributing to Start Your Lab

Start Your Lab materials are all currently under active development. We welcome you to collaborate with us on Start Your Lab's materials as a contributor.

The Open Source Guides website has a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project like Start Your Lab. Contributors and people new to open source alike will find the following guides especially useful:

Start Your Lab has adopted a Code of Conduct that we expect our community members to adhere to. Please read the full text so that you can understand what behaviors will and will not be tolerated.

Get involved

There are many ways to contribute to Start Your Lab, and many of them do not involve writing any code. Here are a few ideas to get involved:

  • Look through the open issues. If you find an issue you would like to fix, open a pull request. Issues tagged as good first issue are a good place to get started.
  • Help us making the materials better. File an issue if you find anything that is confusing or can be improved.
  • Take a look at the features requested by others in the community and consider opening a pull request if you see something you want to work on.

Contributions are very welcome. If you think you need help planning your contribution, please contact us on Twitter at @startyourlab and let us know you are looking for a bit of help. We typically respond within a day or two, and often faster!

Our development process

Start Your Lab uses GitHub repositories as its sources of truth. The active team will be working directly there. All repository changes will be, and have been, public from the beginning.

Reporting new issues

When opening a new issue, always make sure to fill out the issue template. This step is very important! Not doing so may result in your issue not being managed in a timely fashion by a member of the team that maintains Start Your Lab. If this happens, don't take it personally, and feel free to open a new issue once you've gathered all the information required by the template.

  • One bug, one issue: Please report a single bug per issue.
  • Provide reproduction steps: List all the steps necessary to reproduce the issue. The person reading your bug report should be able to follow these steps to reproduce your issue with minimal effort.

Reporting bugs

We use GitHub Issues for tracking, discussing, and fixing our site's bugs. If you would like to report a problem, take a look around and see if someone already opened an issue about it. If you a are certain this is a new, unreported bug, you can submit a bug report.

If you have questions about using Start Your Lab, contact the Start Your Lab Twitter account at @startyourlab, and we will do our best to answer your questions.

You can also file issues as feature requests or enhancements. If you see anything you'd like to be implemented, create an issue with the feature request template

Contributing to the Start Your Lab website

You can learn more about contributing to Start Your Lab's main website by visiting the community contribution guide. If you would like to contribute to other projects, please see the contributing guide for that project's repository or reach out to us on Twitter.

License

By contributing to Start Your Lab, you agree that your contributions will be licensed under its MIT license.