docs: update contributing + readme, add changelog

marcopixel · Dec 1, 2021 · 6b81f3c · 6b81f3c
1 parent 11ad21c
commit 6b81f3c
Show file tree

Hide file tree

Showing 4 changed files with 71 additions and 63 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,24 @@
+# Changelog
+
+All versions upwards from `2.0.0` project will be documented in this file. For all older version, please check the [Releases](https://github.com/marcopixel/r6operators/releases/) tab.
+
+## 2.0.0 (2021-09-08)
+
+### ✨ Features
+
+- 📝 Rewrote library code for better typings, smaller filesize and future features ([6c84917](https://github.com/marcopixel/r6operators/commit/6c8491729761d3929a55597b655f41d091cce0ec))
+- 🎨 Reworked existing operator icons to the new style ([bfac854](https://github.com/marcopixel/r6operators/commit/bfac85442b01429553996428659bae1eee87ffb6), [80dbc5b](https://github.com/marcopixel/r6operators/commit/80dbc5b577449bf39dc50175115fb86c7aa410ea))
+- 🌟 Added Thorn opperator icon & metadata ([11ad21c](https://github.com/marcopixel/r6operators/commit/11ad21c2ae109c867203bc5782cf6bb3804cfb8f))
+
+### 🐛 Bug Fixes
+
+- 🛠 Corrected incorrect metadata on Doc & Thatcher ([bb7e7a5](https://github.com/marcopixel/r6operators/commit/bb7e7a5d185026dfddb24f58da01295f123fa52a))
+
+### 🚨 Breaking Changes
+
+- **BREAKING**: Changed `[op].sex` to `[op].gender` ([b46431e](https://github.com/marcopixel/r6operators/commit/b46431e2e2181083c120948161fe91c77e4fc4cf))
+- **BREAKING**: Renamed `[op].ratings.armor` to `[op].ratings.health` ([4311beb](https://github.com/marcopixel/r6operators/commit/4311beb57cc80ae2562631c83e6d6bbf2bad2b0a))
+- **BREAKING**: PNG files are no longer supplied with the library ([See #1 for more information](https://github.com/marcopixel/r6operators/issues/1#issuecomment-861881904))
+- **BREAKING**: Compiled library & icons path moved from `/lib` to `/dist` ([7756724](https://github.com/marcopixel/r6operators/commit/7756724e0f2d56cf7cc8521da8727c0804af06da))
+
+Thanks to [@danielwerg](https://github.com/danielwerg) for his help on this release 👍
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,92 +4,76 @@ Thank you for your interest to contribute to this project. You're awesome! :+1:
 
 Below here are some guidelines for contributing to this project, please read them before creating a pull request/issue on Github.
 
-Feel free to improve these guidelines with a pull request :)
+Feel free to improve these guidelines with a pull request! 😄
 
-## Creating the icon
+## Getting started
 
-> **Note:** We recommend using Adobe Illustrator for this project. If you do not own Illustrator please make the icon boundaries (white border of the icon) exactly 350 x 350 pt.
+**What does "contributing" mean?**
 
-If you want to create an icon, please use the [template.ai](https://github.com/marcopixel/r6operators/blob/master/src/template.ai) file which is located in the repository root folder.
+Creating an issue is the simplest form of contributing to a project. But there are many ways to contribute, including the following:
 
-The template includes the necessary guides for proper sizing & file layout, which we recommend for you to use since it makes every ones work so much easier :)
+- Updating or correcting documentation
+- Feature requests
+- Bug reports
 
-**Here's an screenshot of the template loaded into Illustrator CC:**
+If you'd like to learn more about contributing in general, the [Guide to Idiomatic Contributing](https://github.com/jonschlinkert/idiomatic-contributing) has a lot of useful information.
 
-> ![Illustrator example](https://i.imgur.com/xpZd4Vs.png)
+## Issues
 
-Also follow these guidelines:
+Please only create issues for bug reports or feature requests. Issues discussing any other topics may be closed by the project's maintainers without further explanation.
 
-- Keep icon boundaries (white border) inside the guides
-- Keep all paths/shapes inside the artboard
-- Rename the artboard & layer to the `OperatorName`
+Do not create issues about bumping dependencies unless a bug has been identified and you can demonstrate that it effects this library.
 
-**Example screenshot of a finished icon:**
+**Help us to help you**
 
-> ![Finished example screenshot](https://i.imgur.com/ZKbBPSe.png)
+Remember that we’re here to help, but not to make guesses about what you need help with:
 
-After you're finished with your icon, save the icon under the `icons` folder (filename in lower-case) in the root directory and continue with the steps down below.
+- Whatever bug or issue you're experiencing, assume that it will not be as obvious to the maintainers as it is to you.
+- Spell it out completely. Keep in mind that maintainers need to think about _all potential use cases_ of a library. It's important that you explain how you're using a library so that maintainers can make that connection and solve the issue.
 
-> Info: If you're using Illustrator, please save your file with the following settings:
->
-> - SVG Profiles: **SVG 1.1**
-> - Type: **SVG**
-> - Subsetting: **None (Use System Fonts)**
-> - Image Location: **Embed**
-> - Preserve Illustrator Editing Capabilities **ON**
-> - CSS Properties: **Style Attributes**
-> - Decimal Places: **3**
-> - Encoding: **Unicode (UTF-8)**
-> - Output fewer <tspan> elements **ON**
-> - Use <textPath> element for Text on Path **ON**
-> - Responsive **ON**
-> - Include Slicing Data **OFF**
-> - Include XMP **OFF**
+_It can't be understated how frustrating and draining it can be to maintainers to have to ask clarifying questions on the most basic things, before it's even possible to start debugging. Please try to make the best use of everyone's time involved, including yourself, by providing this information up front._
 
-## Adding the icon to the package
+### Before creating an issue
 
-> **Note:** This guide requires a little knowledge about Node.js, PATH and Git, if you feel unsure about this skip this step and just create a pull request with the icon only.
+Please try to determine if the issue is caused by an underlying library, and if so, create the issue there. Sometimes this is difficult to know. We only ask that you attempt to give a reasonable attempt to find out. Oftentimes the readme will have advice about where to go to create issues.
 
-#### Requirements:
+Try to follow these guidelines:
 
-- [Node.js](https://nodejs.org/en/)
-- [Yarn](https://yarnpkg.com/)
-- [Inkscape](https://inkscape.org/) (installed on [PATH](https://superuser.com/questions/284342/what-are-path-and-other-environment-variables-and-how-can-i-set-or-use-them), you can use [chocolatey](https://chocolatey.org/packages/InkScape) to automatically install & add it on Windows)
+- **Avoid creating issues for implementation help** - It's much better for discoverability, SEO, and semantics - to keep the issue tracker focused on bugs and feature requests - to ask implementation-related questions please go to [stackoverflow.com](https://stackoverflow.com/)
+- **Investigate the issue** - Search for exising issues (open or closed) that address the issue, and might have even resolved it already.
+- **Check the readme** - oftentimes you will find notes about creating issues, and where to go depending on the type of issue.
+- Create the issue in the appropriate repository.
 
-To setup & install all dependencies for the project, install [Node.js](https://nodejs.org/en/) & [Yarn](https://yarnpkg.com/) and run the following commands in the root directory:
+### Creating an issue
 
-```shell
-yarn install
-```
+Please be as descriptive as possible when creating an issue. Give us the information we need to successfully answer your question or address your issue by answering the following in your issue:
 
-Now open your favorite code editor (we recommend [Visual Studio Code](https://code.visualstudio.com/)) and go to the [`operators.json`](https://github.com/marcopixel/r6operators/blob/master/src/operators.json) file located under the `src` folder.
+- **description**: (required) What is the bug you're experiencing? How are you using this library/app?
+- **version**: (required) please note the version you are using
+- **error messages**: (required) please paste any error messages into the issue, or a [gist](https://gist.github.com/)
 
-There you will find a huge JSON object containing all metadata for all the operators sorted alphabetically (except the recruits, those are at the bottom). From there you just have to create a new object with the same name as your `icon.svg` and fill out the metadata.
+### Closing issues
 
-> ![Screenshot of the JSON file](https://i.imgur.com/HBljxs1.png)
+The original poster or the maintainers may close an issue at any time. Typically, but not exclusively, issues are closed when:
 
-If you did everything correctly, you just have to enter `yarn build` into the command line and it should start the build process automatically. This will clean up any old generated files, generate the icons + javascript files and test them for any errors.
+- The issue is resolved
+- The project's maintainers have determined the issue is out of scope
+- An issue is clearly a duplicate of another issue, in which case the duplicate issue will be linked.
+- A discussion has clearly run its course
 
-Your icons should show up under `lib/icons` in their respective folders and if no errors show up you can go and commit the changes to your pull request.
+## Next steps
 
-## Submitting an icon
+**Tips for creating idiomatic issues**
 
-The best way to contribute an icon is by creating a pull request. They allow for better collaboration and also allow for proper reviews.
+Spending just a little extra time to review best practices and brush up on your contributing skills will, at minimum, make your issue easier to read, easier to resolve, and more likely to be found by others who have the same or similar issue in the future. At best, it will open up doors and potential career opportunities by helping you be at your best.
 
-**Working on your first Pull Request?** You can learn how from this _free_ series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
+The following resources were hand-picked to help you be the most effective contributor you can be:
 
-## Running tests
+- The [Guide to Idiomatic Contributing](https://github.com/jonschlinkert/idiomatic-contributing) is a great place for newcomers to start, but there is also information for experienced contributors there.
+- Take some time to learn basic markdown. We can't stress this enough. Don't start pasting code into GitHub issues before you've taken a moment to review this [markdown cheatsheet](https://gist.github.com/jonschlinkert/5854601)
+- And if you want to really go above and beyond, read [mastering markdown](https://guides.github.com/features/mastering-markdown/).
 
-To run the tests from the command line, simply run the following command:
+At the very least, please try to:
 
-```shell
-yarn test
-```
-
-This will start all tests automatically and will tell you exactly where something went wrong.
-
-## Icon requests
-
-Before creating an icon request, please go to issues and search if someone requested the icon already. If there is an open request, please add a ":+1:" to the main post.
-
-If the icon has not already been requested, [create an issue](https://github.com/marcopixel/r6operators/issues/new?title=Icon%20Request:) with a title of `Icon request: <name>` and add as much information as possible (if possible also add images of the icon, so we can start as soon as possible)
+- Use backticks to wrap code. This ensures that it retains its formatting and isn't modified when it's rendered by GitHub, and makes the code more readable to others
+- When applicable, use syntax highlighting by adding the correct language name after the first "code fence"
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Marco Vockner
+Copyright (c) 2021 Marco Vockner
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -185,7 +185,7 @@ Caught a mistake or want to contribute to the documentation? [Edit this page on
 - [@colebemis](https://github.com/colebemis) for his work on [feather](https://github.com/feathericons/feather), which gave me an awesome reference for this project.
 - [@dtSniper](https://twitter.com/sniperdt) for creating the IQ, Thatcher, Fuze, Glaz, Bandit, Kapkan, Tachanka, Pulse, Sledge and Doc icons.
 - [@joeyfjj](https://twitter.com/joeyfjj) for creating the Goyo, Mute, Smoke, Jäger and Blitz icons.
-- [@LaxisB](https://github.com/LaxisB/) & [@NaughtyMuppet](https://github.com/NaughtyMuppet) for general help on this project. <3
+- [@LaxisB](https://github.com/LaxisB/), [@NaughtyMuppet](https://github.com/NaughtyMuppet) & [@danielwerg](https://github.com/danielwerg) for general help on this project. <3
 
 ## License