From 3abd6c2221f5cd55ae0776573786936c53f1d17f Mon Sep 17 00:00:00 2001 From: rickstaa Date: Mon, 6 Mar 2023 13:31:04 +0100 Subject: [PATCH] docs: update CONTRIBUTING.md --- CONTRIBUTING.md | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bbb58634..55b71ed5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,12 +2,12 @@ We love your input! 🚀 We want to make contributing to this project as easy and transparent as possible, whether it's: -- [Reporting a bug](https://github.com/rickstaa/github-emoji-picker/issues). -- [Discussing the current state of the code](https://github.com/rickstaa/github-emoji-picker/discussions). -- [Submitting a fix](https://github.com/rickstaa/github-emoji-picker/pulls). -- [Proposing new features](https://github.com/rickstaa/github-emoji-picker/issues). -- Becoming a maintainer. -- [Providing translations](https://crowdin.com/project/github-emoji-picker/). +- [Reporting a bug](https://github.com/rickstaa/github-emoji-picker/issues). +- [Discussing the current state of the code](https://github.com/rickstaa/github-emoji-picker/discussions). +- [Submitting a fix](https://github.com/rickstaa/github-emoji-picker/pulls). +- [Proposing new features](https://github.com/rickstaa/github-emoji-picker/issues). +- Becoming a maintainer. +- [Providing translations](https://crowdin.com/project/github-emoji-picker/). ## We Develop with Github @@ -17,13 +17,13 @@ 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. Build the node package using the `npm run build` and `npm run package` commands. -7. 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. Build the node package using the `npm run build` and `npm run package` commands. +7. Issue that pull request! ## Any contributions you make will be under the MIT Software License @@ -35,17 +35,17 @@ We use GitHub issues to track public bugs. Report a bug by [opening a new issue] ## Write bug reports with detail, background, and sample code -[This is an example](http://stackoverflow.com/q/12488905/180626) of a bug report I wrote, and I think it's not a bad model. Here's [another example from Craig Hockenberry](http://www.openradar.me/11905408), an app developer whom I greatly respect. +[This is an example](http://stackoverflow.com/q/12488905/180626) of a bug report, and I think it's a good model. Here's [another example from Craig Hockenberry](http://www.openradar.me/11905408), an app developer greatly respected in the community. **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 what I was seeing. -- 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. [A 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. @@ -55,7 +55,7 @@ We use [prettier](https://prettier.io/) formatter to format our typescript code. ## Provide translations -The local App translations (i.e. header and footer) are provided through [Crowdin](https://crowdin.com/project/github-emoji-picker). Please check out https://crowdin.com/project/github-emoji-picker if you want to add a card translation. The Emoji-Picker translations are handled by the [Emoji Mart package](https://github.com/missive/emoji-mart). If you want to translate parts of the picker, please open an issue at https://github.com/missive/emoji-mart/issues. +The local App translations (i.e. header and footer) are provided through [Crowdin](https://crowdin.com/project/github-emoji-picker). Please check out if you want to add a card translation. The Emoji-Picker translations are handled by the [Emoji Mart package](https://github.com/missive/emoji-mart). If you want to translate parts of the picker, please open an issue at . ## License