Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 1.95 KB

Contributing.md

File metadata and controls

32 lines (21 loc) · 1.95 KB

#Contribute to MiR Community:

Thanks for your interest in contributing to MiR Community!! 🎉 The website is currently maintained by [enter contributors here]. If you have questions at all, reach out and we'll do our best to help you get started. Slack or @mir_community on twitter are the best ways to get in touch.

How to get involved:

New Issues and Bugs

Please check to see if an issue/bug report has already been created. If the report was previously created, please leave a 👍🏿or comment on the existing issue.

Submitting issues

When opening an issue, use a descriptive title and include details on the R environment you are using. Our issue template below helps you remember the most important details to include.

  • Operating System:
  • R Version Used:
  • blogdown Version Used:
  • Any other environment Information:

The folks at reprex are doing this well and leading the masses. Check out the reprex vignette for a few great examples of reproducible examples.

If you're looking for help with your code, consider posting a question on the Slack in the website channel. We believe that help is much more valuable if it's shared publicly, so that more people can benefit from it.

Getting started In order to make changes to MiR Community's website, first fork the codebase, then clone the repository. You'll then be able to build MiR's website from source. Be sure to install blogdown.

Fixing bugs When fixing a bug, first create an issue if one does not already exist. Please add a brief description of what you are fixing -- doesn't need to be long.

Next, create a file named bug_issue[ISSUE NUMBER].R for the bug you're fixing. Next, add and commit your test file (if you have one) referencing the issue number in the commit message.

Code of conduct MiR Community adheres to the (Contributor Covenant Code of Conduct)[https://www.contributor-covenant.org/]. By participating, you are expected to uphold this code too.