From dadc96df8ebf09676dfd11774ea031999d083481 Mon Sep 17 00:00:00 2001 From: rickstaa Date: Mon, 6 Mar 2023 19:43:30 +0100 Subject: [PATCH] refactor: fix CONTRIBUTING formatting --- CONTRIBUTING.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9e6f1e1..d31efc9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,11 +2,11 @@ We love your input! 🚀 We want to make contributing to this project as easy and transparent as possible, whether it's: -- Reporting a bug. -- Discussing the current state of the code. -- Submitting a fix. -- Proposing new features. -- Becoming a maintainer. +- Reporting a bug. +- Discussing the current state of the code. +- Submitting a fix. +- Proposing new features. +- Becoming a maintainer. ## We Develop with Github @@ -16,12 +16,12 @@ We use github to host code, to track issues and feature requests, as well as acc Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow)). We actively welcome your pull requests: -1. Fork the repo and create your branch from `master`. -2. If you've added code that should be tested, add tests. -3. If you've changed APIs, update the documentation. -4. Ensure the test suite passes. -5. Make sure your code lints. -6. Issue that pull request! +1. Fork the repo and create your branch from `master`. +2. If you've added code that should be tested, add tests. +3. If you've changed APIs, update the documentation. +4. Ensure the test suite passes. +5. Make sure your code lints. +6. Issue that pull request! ## Any contributions you make will be under the MIT Software License @@ -37,13 +37,13 @@ We use GitHub issues to track public bugs. Report a bug by [opening a new issue] **Great Bug Reports** tend to have: -- A quick summary and/or background. -- Steps to reproduce: - - Be specific! - - Give sample code if you can. [My stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that _anyone_ with a base R setup can run to reproduce the error. -- What you expected would happen. -- What actually happens. -- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work). +- A quick summary and/or background. +- Steps to reproduce: + - Be specific! + - Give sample code if you can. [My stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that _anyone_ with a base R setup can run to reproduce the error. +- What you expected would happen. +- What actually happens. +- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work). People _love_ thorough bug reports. I'm not even kidding.