From e722ef899cfb6737cc39a83d2e2fd69045491daf Mon Sep 17 00:00:00 2001 From: Tixie Date: Mon, 3 Jan 2022 13:38:38 +0100 Subject: [PATCH] Add contribution guide --- CONTRIBUTING.md | 32 ++++++++++ package-lock.json | 2 + src/_includes/add-plugin.svg | 12 ++++ src/_includes/footer.njk | 12 +++- src/sass/4-base/_09-footer.scss | 3 +- src/sass/5-modules/contribute.scss | 96 ++++++++++++++++++++++++++++++ src/sass/style.scss | 1 + 7 files changed, 156 insertions(+), 2 deletions(-) create mode 100644 CONTRIBUTING.md create mode 100644 src/_includes/add-plugin.svg create mode 100644 src/sass/5-modules/contribute.scss diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..eedb800 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,32 @@ +# Thank you! 💜 + +Thank you for contributing to our awesome resources. + +## Todo list + +1. Create a valid JSON file in the `/plugins` folder +2. Name the file as a "kebab case" (something-like-this) version of the title +3. Add the following keys to the JSON file: + 1. `id`: an integer number incrementing the current higher plugin id + 2. `title`: The plugin name followed by a very short description of what's kind of plugin is it (a few words at most) + 3. `image`: the thumbnail file name (more infos in the next list item) + 4. `description`: A short description about the plugin, a few keywords are welcome to help the search engine + 5. `url_github`: Link to Github repo *(Optional as long as there is at least one url)* + 6. `url_npm`: Link to NPM repo *(Optional as long as there is at least one url)* + 6. `url_demo`: Link to plugin's website or a demo page *(Optional as long as there is at least one url)* +4. Add a thumbnail picture in the `/uploads` folder + - PNG, JPG and GIF formats only are authorized for now + - Measuring a least 616×390px + - Prefixed with the same id you put in the JSON file *(example: 42-mysuperplugin.png)*. + +## Guidelines + +- **One item** per Pull Request. + +- The resource **must** not need any external dependencies (like jQuery, React.js, Vue.js), that's the all point of a vanilla JS plugins. + +- The todolist bellow must have been completed. + +- *(optional)* Allow modification from maintener, to avoid waisting time if your pull-request only need a few fixes or if the todolist isn't completed + +## Thank you! 💜 diff --git a/package-lock.json b/package-lock.json index 01d0863..9f89fb2 100644 --- a/package-lock.json +++ b/package-lock.json @@ -5,7 +5,9 @@ "requires": true, "packages": { "": { + "name": "vanillalist", "version": "1.0.0", + "license": "Anti-Fascist MIT License", "dependencies": { "@11ty/eleventy": "^0.11.1", "autoprefixer": "^9.8.6", diff --git a/src/_includes/add-plugin.svg b/src/_includes/add-plugin.svg new file mode 100644 index 0000000..cbcb96c --- /dev/null +++ b/src/_includes/add-plugin.svg @@ -0,0 +1,12 @@ + + + + + + + + + + + + diff --git a/src/_includes/footer.njk b/src/_includes/footer.njk index efbfbd3..5b82ab9 100644 --- a/src/_includes/footer.njk +++ b/src/_includes/footer.njk @@ -1,3 +1,13 @@ -