├── .commitlintrc.json ├── images ├── logo.png └── preview.png ├── .github ├── FUNDING.yml ├── ISSUE_TEMPLATE │ ├── general_issue.md │ ├── bug_report.md │ └── feature_request.md ├── dependabot.yml ├── chglog │ ├── RELEASE.tpl.md │ └── release.yml ├── workflows │ └── stale.yml └── PULL_REQUEST_TEMPLATE │ └── pull_request_template.md ├── .editorconfig ├── CHANGELOG.md ├── .versionrc.json ├── shades-of-purple.yaml ├── LICENSE ├── package.json ├── README.md ├── .gitignore ├── CODE_OF_CONDUCT.md └── CONTRIBUTING.md /.commitlintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": ["@commitlint/config-conventional"] 3 | } 4 | -------------------------------------------------------------------------------- /images/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ahmadawais/base16-shades-of-purple/HEAD/images/logo.png -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | issuehunt: demartini 2 | ko_fi: demartini 3 | liberapay: demartini 4 | patreon: demartini -------------------------------------------------------------------------------- /images/preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ahmadawais/base16-shades-of-purple/HEAD/images/preview.png -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/general_issue.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: General issue 3 | about: If you want to leave a general comment 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # http://editorconfig.org 2 | 3 | root = true 4 | 5 | [*] 6 | charset = utf-8 7 | end_of_line = lf 8 | indent_size = 2 9 | indent_style = space 10 | insert_final_newline = true 11 | trim_trailing_whitespace = true 12 | 13 | [*.md] 14 | trim_trailing_whitespace = false 15 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | # Maintain dependencies for npm 4 | - package-ecosystem: "npm" 5 | directory: "/" 6 | schedule: 7 | interval: "daily" 8 | 9 | # Maintain dependencies for GitHub Actions 10 | - package-ecosystem: "github-actions" 11 | directory: "/" 12 | schedule: 13 | interval: "weekly" 14 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. 4 | 5 | ## 0.1.0 (2020-07-23) 6 | 7 | 8 | ### Miscellaneous Chores 9 | 10 | * **release:** initial commit ([99debd8](https://github.com/demartini/base16-shades-of-purple/commit/99debd8d08e8c2e6affba4fd4da1f0ee82671491)) 11 | -------------------------------------------------------------------------------- /.versionrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "types": [ 3 | { "type": "feat", "section": "Features" }, 4 | { "type": "fix", "section": "Bug Fixes" }, 5 | { "type": "perf", "section": "Performance Improvements" }, 6 | { "type": "chore", "section": "Miscellaneous Chores" }, 7 | { "type": "refactor", "section": "Code Refactoring" }, 8 | { "type": "ci", "section": "Continuous Integration" }, 9 | { "type": "test", "section": "Tests", "hidden": true }, 10 | { "type": "build", "section": "Build System", "hidden": true } 11 | ] 12 | } 13 | -------------------------------------------------------------------------------- /.github/chglog/RELEASE.tpl.md: -------------------------------------------------------------------------------- 1 | {{ range .Versions }} 2 | ## {{ if .Tag.Previous }}[{{ .Tag.Name }}]({{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}){{ else }}{{ .Tag.Name }}{{ end }} ({{ datetime "2006-01-02" .Tag.Date }}) 3 | 4 | {{ range .CommitGroups -}} 5 | ### {{ .Title }} 6 | 7 | {{ range .Commits -}} 8 | * {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }} 9 | {{ end }} 10 | {{ end -}} 11 | 12 | {{- if .RevertCommits -}} 13 | ### Reverts 14 | 15 | {{ range .RevertCommits -}} 16 | * {{ .Revert.Header }} 17 | {{ end }} 18 | {{ end -}} 19 | 20 | {{- if .NoteGroups -}} 21 | {{ range .NoteGroups -}} 22 | ### {{ .Title }} 23 | 24 | {{ range .Notes }} 25 | {{ .Body }} 26 | {{ end }} 27 | {{ end -}} 28 | {{ end -}} 29 | {{ end -}} -------------------------------------------------------------------------------- /.github/chglog/release.yml: -------------------------------------------------------------------------------- 1 | style: github 2 | template: RELEASE.tpl.md 3 | info: 4 | repository_url: https://github.com/demartini/base16-shades-of-purple 5 | options: 6 | commits: 7 | # filters: 8 | # Type: 9 | # - feat 10 | # - fix 11 | # - perf 12 | # - refactor 13 | commit_groups: 14 | title_maps: 15 | feat: Features 16 | fix: Bug Fixes 17 | perf: Performance Improvements 18 | chore: Miscellaneous Chores 19 | refactor: Code Refactoring 20 | ci: Continuous Integration 21 | header: 22 | pattern: "^(\\w*)(?:\\(([\\w\\$\\.\\-\\*\\s]*)\\))?\\:\\s(.*)$" 23 | pattern_maps: 24 | - Type 25 | - Scope 26 | - Subject 27 | notes: 28 | keywords: 29 | - BREAKING CHANGES 30 | -------------------------------------------------------------------------------- /shades-of-purple.yaml: -------------------------------------------------------------------------------- 1 | scheme: "Shades of Purple" 2 | author: "Iolar Demartini Junior (http://github.com/demartini) based on Shades of Purple Theme (https://github.com/ahmadawais/shades-of-purple-vscode)." 3 | base00: "1e1e3f" # default background 4 | base01: "43d426" # lighter background (status bar) 5 | base02: "f1d000" # selection background 6 | base03: "808080" # comments, invisibles 7 | base04: "6871ff" # dark foreground (status bar) 8 | base05: "c7c7c7" # default foreground 9 | base06: "ff77ff" # light foreground 10 | base07: "ffffff" # light background 11 | base08: "d90429" # variables 12 | base09: "f92a1c" # constants 13 | base0A: "ffe700" # search text background 14 | base0B: "3ad900" # strings 15 | base0C: "00c5c7" # regex, escaped chars 16 | base0D: "6943ff" # functions 17 | base0E: "ff2c70" # keywords 18 | base0F: "79e8fb" # deprecations 19 | -------------------------------------------------------------------------------- /.github/workflows/stale.yml: -------------------------------------------------------------------------------- 1 | name: Mark stale issues and pull requests 2 | 3 | on: 4 | schedule: 5 | - cron: "0 0 * * *" 6 | 7 | jobs: 8 | stale: 9 | runs-on: ubuntu-latest 10 | 11 | steps: 12 | - name: Close Stale Issues 13 | uses: actions/stale@v3.0.8 14 | with: 15 | repo-token: ${{ secrets.GITHUB_TOKEN }} 16 | stale-issue-message: "This issue has been automatically marked as stale because it has been open 30 days with no activity." 17 | stale-pr-message: "This pull request has been automatically marked as stale because it has been open 30 days with no activity." 18 | stale-issue-label: "stale-issue" 19 | exempt-issue-labels: "enhancement,documentation,good-first-issue" 20 | stale-pr-label: "stale-pr" 21 | exempt-pr-labels: "work-in-progress" 22 | days-before-stale: 30 23 | days-before-close: -1 24 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2020 Iolar Demartini Junior 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '[Bug] Title...' 5 | labels: 'bug' 6 | assignees: '' 7 | 8 | --- 9 | 10 | ### Checklist 11 | 12 | 13 | * [ ] I have read the [Contributing Guidelines](https://github.com/demartini/base16-shades-of-purple/blob/master/CONTRIBUTING.md) for this project. 14 | * [ ] I agree to follow the [Code of Conduct](https://github.com/demartini/base16-shades-of-purple/blob/master/CODE_OF_CONDUCT.md) that this project adheres to. 15 | * [ ] I have searched the issue tracker for an issue that matches the one I want to file, without success. 16 | 17 | ### Actual Behavior 18 | 19 | 20 | ### Steps To Reproduce 21 | 22 | 23 | ### Expected Behavior 24 | 25 | 26 | ### Screenshots 27 | 28 | 29 | ### Additional Information 30 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '[Feature Request] Title...' 5 | labels: 'enhancement' 6 | assignees: '' 7 | 8 | --- 9 | 10 | ### Checklist 11 | 12 | 13 | * [ ] I have read the [Contributing Guidelines](https://github.com/demartini/base16-shades-of-purple/blob/master/CONTRIBUTING.md) for this project. 14 | * [ ] I agree to follow the [Code of Conduct](https://github.com/demartini/base16-shades-of-purple/blob/master/CODE_OF_CONDUCT.md) that this project adheres to. 15 | * [ ] I have searched the issue tracker for an issue that matches the one I want to file, without success. 16 | 17 | ### Problem Description 18 | 19 | 20 | ### Proposed Solution 21 | 22 | 23 | ### Alternatives Considered 24 | 25 | 26 | ### Screenshots 27 | 28 | 29 | ### Additional Information 30 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "private": true, 3 | "name": "base16-shades-of-purple", 4 | "description": "Base16 color scheme based on Shades of Purple theme", 5 | "version": "0.1.0", 6 | "author": { 7 | "name": "Iolar Demartini Junior", 8 | "email": "iolardemartini@gmail.com", 9 | "url": "https://demartini.dev" 10 | }, 11 | "contributors": [ 12 | { 13 | "name": "Shades of Purple for Base16 Contributors", 14 | "url": "https://github.com/demartini/base16-shades-of-purple/graphs/contributors" 15 | } 16 | ], 17 | "repository": { 18 | "type": "git", 19 | "url": "git+https://github.com/demartini/base16-shades-of-purple.git" 20 | }, 21 | "keywords": [ 22 | "shades of purple", 23 | "base16", 24 | "theme", 25 | "purple" 26 | ], 27 | "license": "MIT", 28 | "bugs": { 29 | "url": "https://github.com/demartini/base16-shades-of-purple/issues" 30 | }, 31 | "homepage": "https://github.com/demartini/base16-shades-of-purple#readme", 32 | "devDependencies": { 33 | "@commitlint/cli": "^9.1.1", 34 | "@commitlint/config-conventional": "^9.1.1", 35 | "husky": "^4.2.5", 36 | "standard-version": "^8.0.2" 37 | }, 38 | "scripts": { 39 | "release": "standard-version" 40 | }, 41 | "husky": { 42 | "hooks": { 43 | "commit-msg": "commitlint -E HUSKY_GIT_PARAMS" 44 | } 45 | } 46 | } 47 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE/pull_request_template.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | Which issue(s) this PR fixes (If applicable): # 4 | 5 | 6 | ### PR Checklist 7 | 8 | 9 | - [ ] Read the [contributing guidelines](https://github.com/demartini/base16-shades-of-purple/blob/master/CONTRIBUTING.md). 10 | - [ ] My code follows the code [style guidelines](https://github.com/demartini/base16-shades-of-purple/blob/master/CONTRIBUTING.md#style-guides). 11 | - [ ] PR title follows the [commit guidelines](https://github.com/demartini/base16-shades-of-purple/blob/master/CONTRIBUTING.md#commit-messages). 12 | - [ ] Relevant documentation is changed or added. 13 | - [ ] This is **NOT A BREAKING CHANGE**. 14 | 15 | ### What kind of change does this PR introduce? 16 | 17 | 18 | - [ ] Bugfix 19 | - [ ] Feature 20 | - [ ] Code style update (formatting) 21 | - [ ] Refactoring (no functional changes, no api changes) 22 | - [ ] Build or CI related changes 23 | - [ ] Documentation content changes 24 | - [ ] Project automation 25 | - [ ] Other... Please describe: 26 | 27 | ### Description of Change 28 | 29 | 30 | ### What is the current behavior? 31 | 32 | 33 | ### What is the new behavior? 34 | 35 | 36 | ### Does this PR introduce a breaking change? 37 | 38 | 39 | ### Screenshots 40 | 41 | 42 | ### Other Information 43 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 | 3 | Logo 4 | 5 |
6 |

Shades of Purple for Base16

7 |
Base16 color scheme based on the amazing VSCode theme Shades of Purple by Ahmad Awais.
8 |
9 |
10 | 11 | GitHub stars 12 | 13 | 14 | GitHub forks 15 | 16 | 17 | GitHub issues 18 | 19 | 20 | GitHub contributors 21 | 22 | 23 | GitHub 24 | 25 |
26 |
27 |
28 | Report Bug 29 | - 30 | Request Feature 31 |
32 | 33 | ## Table of Contents 34 | 35 | - [Table of Contents](#table-of-contents) 36 | - [Screenshots](#screenshots) 37 | - [Installation](#installation) 38 | - [Roadmap](#roadmap) 39 | - [Contributing](#contributing) 40 | - [Contributors](#contributors) 41 | - [Inspired By](#inspired-by) 42 | - [Thanks To](#thanks-to) 43 | - [Changelog](#changelog) 44 | - [License](#license) 45 | 46 | ## Screenshots 47 | 48 |

49 | Preview 50 |

51 | 52 | ## Installation 53 | 54 | 1. Install a [base16 builder](https://github.com/chriskempson/base16#builder-repositories). I like [pybase16](https://github.com/InspectorMustache/base16-builder-python), so this is what we're going to use in these instructions. 55 | 2. Make a folder to hold all the builder's files. For example: `~/base16`. 56 | 3. In that folder, run `pybase16 update`. This will download all of the official base16 [schemes](https://github.com/chriskempson/base16#scheme-repositories) and [templates](https://github.com/chriskempson/base16#template-repositories). 57 | 4. Now that all of the official [schemes](https://github.com/chriskempson/base16#scheme-repositories) and [templates](https://github.com/chriskempson/base16#template-repositories) have been downloaded, run `pybase16 build -s shades-of-purple`. 58 | 5. There will now be an `output` folder with all of the generated themes for various applications. 59 | 60 | Alternatively, if you don't want to mess with the builders, I went ahead and generated all the output themes and sent them to another repository [here](https://github.com/demartini/base16-shades-of-purple-exported-themes). 61 | 62 | ## Roadmap 63 | 64 | See the [open issues](https://github.com/demartini/base16-shades-of-purple/issues) for a list of proposed features (and known issues). 65 | 66 | ## Contributing 67 | 68 | If you are interested in helping contribute, please take a look at our [Contributing](CONTRIBUTING.md) guide. 69 | 70 | ### Contributors 71 | 72 | 73 | 74 | 75 | 76 | ## Inspired By 77 | 78 | - The amazing VSCode theme [Shades of Purple](https://github.com/ahmadawais/shades-of-purple-vscode) by [Ahmad Awais](https://github.com/ahmadawais). 79 | 80 | ## Thanks To 81 | 82 | - [Chris Kempson](https://github.com/chriskempson/base16) for the logo. 83 | - [Alex Meyer](https://github.com/reyemxela/base16-helios-scheme) for the installation instructions. 84 | 85 | ## Changelog 86 | 87 | See [Changelog](CHANGELOG.md) for a human-readable history of changes. 88 | 89 | ## License 90 | 91 | Distributed under the MIT License. See [LICENSE](LICENSE) for more information. -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # File created using '.gitignore Generator' for Visual Studio Code: https://bit.ly/vscode-gig 2 | 3 | # Created by https://www.toptal.com/developers/gitignore/api/windows,visualstudiocode,node,macos,linux 4 | # Edit at https://www.toptal.com/developers/gitignore?templates=windows,visualstudiocode,node,macos,linux 5 | 6 | ### Linux ### 7 | *~ 8 | 9 | # temporary files which can be created if a process still has a handle open of a deleted file 10 | .fuse_hidden* 11 | 12 | # KDE directory preferences 13 | .directory 14 | 15 | # Linux trash folder which might appear on any partition or disk 16 | .Trash-* 17 | 18 | # .nfs files are created when an open file is removed but is still being accessed 19 | .nfs* 20 | 21 | ### macOS ### 22 | # General 23 | .DS_Store 24 | .AppleDouble 25 | .LSOverride 26 | 27 | # Icon must end with two \r 28 | Icon 29 | 30 | # Thumbnails 31 | ._* 32 | 33 | # Files that might appear in the root of a volume 34 | .DocumentRevisions-V100 35 | .fseventsd 36 | .Spotlight-V100 37 | .TemporaryItems 38 | .Trashes 39 | .VolumeIcon.icns 40 | .com.apple.timemachine.donotpresent 41 | 42 | # Directories potentially created on remote AFP share 43 | .AppleDB 44 | .AppleDesktop 45 | Network Trash Folder 46 | Temporary Items 47 | .apdisk 48 | 49 | ### Node ### 50 | # Logs 51 | logs 52 | *.log 53 | npm-debug.log* 54 | yarn-debug.log* 55 | yarn-error.log* 56 | lerna-debug.log* 57 | 58 | # Diagnostic reports (https://nodejs.org/api/report.html) 59 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 60 | 61 | # Runtime data 62 | pids 63 | *.pid 64 | *.seed 65 | *.pid.lock 66 | 67 | # Directory for instrumented libs generated by jscoverage/JSCover 68 | lib-cov 69 | 70 | # Coverage directory used by tools like istanbul 71 | coverage 72 | *.lcov 73 | 74 | # nyc test coverage 75 | .nyc_output 76 | 77 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 78 | .grunt 79 | 80 | # Bower dependency directory (https://bower.io/) 81 | bower_components 82 | 83 | # node-waf configuration 84 | .lock-wscript 85 | 86 | # Compiled binary addons (https://nodejs.org/api/addons.html) 87 | build/Release 88 | 89 | # Dependency directories 90 | node_modules/ 91 | jspm_packages/ 92 | 93 | # TypeScript v1 declaration files 94 | typings/ 95 | 96 | # TypeScript cache 97 | *.tsbuildinfo 98 | 99 | # Optional npm cache directory 100 | .npm 101 | 102 | # Optional eslint cache 103 | .eslintcache 104 | 105 | # Microbundle cache 106 | .rpt2_cache/ 107 | .rts2_cache_cjs/ 108 | .rts2_cache_es/ 109 | .rts2_cache_umd/ 110 | 111 | # Optional REPL history 112 | .node_repl_history 113 | 114 | # Output of 'npm pack' 115 | *.tgz 116 | 117 | # Yarn Integrity file 118 | .yarn-integrity 119 | 120 | # dotenv environment variables file 121 | .env 122 | .env.test 123 | 124 | # parcel-bundler cache (https://parceljs.org/) 125 | .cache 126 | 127 | # Next.js build output 128 | .next 129 | 130 | # Nuxt.js build / generate output 131 | .nuxt 132 | dist 133 | 134 | # Gatsby files 135 | .cache/ 136 | # Comment in the public line in if your project uses Gatsby and not Next.js 137 | # https://nextjs.org/blog/next-9-1#public-directory-support 138 | # public 139 | 140 | # vuepress build output 141 | .vuepress/dist 142 | 143 | # Serverless directories 144 | .serverless/ 145 | 146 | # FuseBox cache 147 | .fusebox/ 148 | 149 | # DynamoDB Local files 150 | .dynamodb/ 151 | 152 | # TernJS port file 153 | .tern-port 154 | 155 | # Stores VSCode versions used for testing VSCode extensions 156 | .vscode-test 157 | 158 | ### VisualStudioCode ### 159 | .vscode/* 160 | !.vscode/settings.json 161 | !.vscode/tasks.json 162 | !.vscode/launch.json 163 | !.vscode/extensions.json 164 | *.code-workspace 165 | 166 | ### VisualStudioCode Patch ### 167 | # Ignore all local history of files 168 | .history 169 | 170 | ### Windows ### 171 | # Windows thumbnail cache files 172 | Thumbs.db 173 | Thumbs.db:encryptable 174 | ehthumbs.db 175 | ehthumbs_vista.db 176 | 177 | # Dump file 178 | *.stackdump 179 | 180 | # Folder config file 181 | [Dd]esktop.ini 182 | 183 | # Recycle Bin used on file shares 184 | $RECYCLE.BIN/ 185 | 186 | # Windows Installer files 187 | *.cab 188 | *.msi 189 | *.msix 190 | *.msm 191 | *.msp 192 | 193 | # Windows shortcuts 194 | *.lnk 195 | 196 | # End of https://www.toptal.com/developers/gitignore/api/windows,visualstudiocode,node,macos,linux 197 | 198 | # Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option) 199 | 200 | src/shades-of-purple/Cached Theme.pak 201 | src/shades-of-purple.zip 202 | src/shades-of-purple.pem 203 | src/shades-of-purple.crx 204 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | 2 | # Contributor Covenant Code of Conduct 3 | 4 | ## Our Pledge 5 | 6 | We as members, contributors, and leaders pledge to make participation in our 7 | community a harassment-free experience for everyone, regardless of age, body 8 | size, visible or invisible disability, ethnicity, sex characteristics, gender 9 | identity and expression, level of experience, education, socio-economic status, 10 | nationality, personal appearance, race, religion, or sexual identity 11 | and orientation. 12 | 13 | We pledge to act and interact in ways that contribute to an open, welcoming, 14 | diverse, inclusive, and healthy community. 15 | 16 | ## Our Standards 17 | 18 | Examples of behavior that contributes to a positive environment for our 19 | community include: 20 | 21 | * Demonstrating empathy and kindness toward other people 22 | * Being respectful of differing opinions, viewpoints, and experiences 23 | * Giving and gracefully accepting constructive feedback 24 | * Accepting responsibility and apologizing to those affected by our mistakes, 25 | and learning from the experience 26 | * Focusing on what is best not just for us as individuals, but for the 27 | overall community 28 | 29 | Examples of unacceptable behavior include: 30 | 31 | * The use of sexualized language or imagery, and sexual attention or 32 | advances of any kind 33 | * Trolling, insulting or derogatory comments, and personal or political attacks 34 | * Public or private harassment 35 | * Publishing others' private information, such as a physical or email 36 | address, without their explicit permission 37 | * Other conduct which could reasonably be considered inappropriate in a 38 | professional setting 39 | 40 | ## Enforcement Responsibilities 41 | 42 | Community leaders are responsible for clarifying and enforcing our standards of 43 | acceptable behavior and will take appropriate and fair corrective action in 44 | response to any behavior that they deem inappropriate, threatening, offensive, 45 | or harmful. 46 | 47 | Community leaders have the right and responsibility to remove, edit, or reject 48 | comments, commits, code, wiki edits, issues, and other contributions that are 49 | not aligned to this Code of Conduct, and will communicate reasons for moderation 50 | decisions when appropriate. 51 | 52 | ## Scope 53 | 54 | This Code of Conduct applies within all community spaces, and also applies when 55 | an individual is officially representing the community in public spaces. 56 | Examples of representing our community include using an official e-mail address, 57 | posting via an official social media account, or acting as an appointed 58 | representative at an online or offline event. 59 | 60 | ## Enforcement 61 | 62 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 63 | reported to the community leaders responsible for enforcement at 64 | iolardemartini@gmail.com. 65 | All complaints will be reviewed and investigated promptly and fairly. 66 | 67 | All community leaders are obligated to respect the privacy and security of the 68 | reporter of any incident. 69 | 70 | ## Enforcement Guidelines 71 | 72 | Community leaders will follow these Community Impact Guidelines in determining 73 | the consequences for any action they deem in violation of this Code of Conduct: 74 | 75 | ### 1. Correction 76 | 77 | **Community Impact**: Use of inappropriate language or other behavior deemed 78 | unprofessional or unwelcome in the community. 79 | 80 | **Consequence**: A private, written warning from community leaders, providing 81 | clarity around the nature of the violation and an explanation of why the 82 | behavior was inappropriate. A public apology may be requested. 83 | 84 | ### 2. Warning 85 | 86 | **Community Impact**: A violation through a single incident or series 87 | of actions. 88 | 89 | **Consequence**: A warning with consequences for continued behavior. No 90 | interaction with the people involved, including unsolicited interaction with 91 | those enforcing the Code of Conduct, for a specified period of time. This 92 | includes avoiding interactions in community spaces as well as external channels 93 | like social media. Violating these terms may lead to a temporary or 94 | permanent ban. 95 | 96 | ### 3. Temporary Ban 97 | 98 | **Community Impact**: A serious violation of community standards, including 99 | sustained inappropriate behavior. 100 | 101 | **Consequence**: A temporary ban from any sort of interaction or public 102 | communication with the community for a specified period of time. No public or 103 | private interaction with the people involved, including unsolicited interaction 104 | with those enforcing the Code of Conduct, is allowed during this period. 105 | Violating these terms may lead to a permanent ban. 106 | 107 | ### 4. Permanent Ban 108 | 109 | **Community Impact**: Demonstrating a pattern of violation of community 110 | standards, including sustained inappropriate behavior, harassment of an 111 | individual, or aggression toward or disparagement of classes of individuals. 112 | 113 | **Consequence**: A permanent ban from any sort of public interaction within 114 | the community. 115 | 116 | ## Attribution 117 | 118 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 119 | version 2.0, available at 120 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. 121 | 122 | Community Impact Guidelines were inspired by [Mozilla's code of conduct 123 | enforcement ladder](https://github.com/mozilla/diversity). 124 | 125 | [homepage]: https://www.contributor-covenant.org 126 | 127 | For answers to common questions about this code of conduct, see the FAQ at 128 | https://www.contributor-covenant.org/faq. Translations are available at 129 | https://www.contributor-covenant.org/translations. 130 | 131 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | First of all, thanks for thinking of contributing to this project! 👏 4 | 5 | Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. 6 | 7 | As a contributor, here are the guidelines we would like you to follow: 8 | 9 | ## Table of Contents 10 | 11 | - [Table of Contents](#table-of-contents) 12 | - [Code of Conduct](#code-of-conduct) 13 | - [How can I contribute?](#how-can-i-contribute) 14 | - [Give Feedback on Issues](#give-feedback-on-issues) 15 | - [Fix bugs and implement features](#fix-bugs-and-implement-features) 16 | - [Using the issue tracker](#using-the-issue-tracker) 17 | - [Bug report](#bug-report) 18 | - [Feature request](#feature-request) 19 | - [Submitting a Pull Request](#submitting-a-pull-request) 20 | - [Style Guides](#style-guides) 21 | - [Commit Messages](#commit-messages) 22 | 23 | We also recommend that you read [How to Contribute to Open Source](https://opensource.guide/how-to-contribute). 24 | 25 | ## Code of Conduct 26 | 27 | Please note that this project have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project. 28 | 29 | ## How can I contribute? 30 | 31 | ### Give Feedback on Issues 32 | 33 | Some issues are created without information requested in the [Bug report guideline](#bug-report). Help make them easier to resolve by adding any relevant information. 34 | 35 | Issues with the **`enhancement`** label are meant to discuss the implementation of new features. Participating in the discussion is a good opportunity to get involved and influence our future direction. 36 | 37 | ### Fix bugs and implement features 38 | 39 | Confirmed bugs and ready-to-implement features are marked with the **`help wanted`** label. Post a comment on an issue to indicate you would like to work on it and to request help from the **maintainers** and the **community**. 40 | 41 | ## Using the issue tracker 42 | 43 | The issue tracker is the channel for [bug reports](#bug-report), [features requests](#feature-request) and [submitting pull requests](#submitting-a-pull-request) only. 44 | 45 | Before opening an issue or a Pull Request, please use the **GitHub issue search** to make sure the bug or feature request hasn't been already reported or fixed. 46 | 47 | ### Bug report 48 | 49 | A good bug report shouldn't leave others needing to chase you for more information. Please try to be as detailed as possible in your report and fill the information requested in the **Bug report template**. 50 | 51 | ### Feature request 52 | 53 | Feature requests are welcome, but take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible and fill the information requested in the **Feature request template**. 54 | 55 | ## Submitting a Pull Request 56 | 57 | Good pull requests, whether patches, improvements, or new features, are a fantastic help. They should remain focused in scope and avoid containing unrelated commits. 58 | 59 | **Please ask first** before embarking on any significant pull requests (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project. 60 | 61 | If you have never created a pull request before, welcome 🎉 😄. [Here is a great tutorial](https://opensource.guide/how-to-contribute/#opening-a-pull-request) on how to send one. 😃 62 | 63 | This is our preferred process for opening a PR on GitHub: 64 | 65 | 1. Fork this repository 66 | 2. Create your feature branch (`git checkout -b feature/AmazingFeature`) 67 | 3. Commit your changes (`git commit -m 'Add some AmazingFeature'`) 68 | 4. Push to the branch (`git push origin feature/AmazingFeature`) 69 | 5. Open a pull request 70 | 71 | ## Style Guides 72 | 73 | ### Commit Messages 74 | 75 | This project uses the [conventional commit](https://www.conventionalcommits.org) for your commit messages. This format is used to generate changelogs and ensures consistency and better filtering. 76 | 77 | Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**: 78 | 79 | ```commit 80 | (): 81 | 82 | 83 | 84 |