From aa37ca448f6f8b26a26db5a739f984a872b5f6f5 Mon Sep 17 00:00:00 2001 From: Troy Prince Date: Thu, 1 Jul 2021 15:02:49 -0400 Subject: [PATCH 1/3] License, Code of Conduct, npm.js version on README --- CODE_OF_CONDUCT.md | 76 ++++++++++++++++++++++++++++++++++++++++++++++ LICENSE | 9 ++++++ README.md | 7 ++--- 3 files changed, 88 insertions(+), 4 deletions(-) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 LICENSE diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..3414fda --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the team at opensource@lab49.com. +All complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..20c3c1d --- /dev/null +++ b/LICENSE @@ -0,0 +1,9 @@ +MIT License + +Copyright (c) Lab49 (lab49.com) + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 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. diff --git a/README.md b/README.md index 53492c5..ade94f4 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # angular-value-flash -![github action status](https://github.com/lab49/angular-value-flash/actions/workflows/github-actions.yml/badge.svg?branch=main) -[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) +![github action status](https://github.com/lab49/angular-value-flash/actions/workflows/github-actions.yml/badge.svg?branch=main) [![npm version](https://img.shields.io/npm/v/angular-value-flash?label=version&color=%2354C536&logo=npm)](https://www.npmjs.com/package/angular-value-flash) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](code_of_conduct.md) `angular-value-flash` will display a flashed value on screen based on some value change. This pattern is extremely common in financial applications, and at Lab49, we're focused on the finance industry. @@ -132,13 +131,13 @@ MIT @ [Lab49](https://lab49.com) These items are very high level right now. Further discussion and proper roadmap planning will happen in GitHub issues and projects. - [ ] Finalize CI process for publishing. -- [ ] Add a code of conduct. - [ ] Add a contributing guide. - [ ] Create a feature roadmap. - [ ] Publish code coverage to codecov.io. -- [ ] Finanlize README.md (logo, coverage/version link info, API documentation). +- [ ] Finanlize README.md (logo, coverage info). - [ ] Expand Storybook demos. - [ ] Expand unit tests. +- [ ] Publish compodoc documentation. ## Sponsored by Lab49 From 4545ef1c6027de63fc700d13ba8373284ff82353 Mon Sep 17 00:00:00 2001 From: Troy Prince Date: Thu, 1 Jul 2021 15:04:05 -0400 Subject: [PATCH 2/3] package version --- projects/value-flash/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/projects/value-flash/package.json b/projects/value-flash/package.json index 92585d2..9802958 100644 --- a/projects/value-flash/package.json +++ b/projects/value-flash/package.json @@ -1,6 +1,6 @@ { "name": "angular-value-flash", - "version": "1.0.4", + "version": "1.0.5", "description": "Flash on value change. Perfect for financial applicaitons.", "license": "MIT", "repository": "@lab49/angular-value-flash", From 22b6b13eb33bb808d9e90f0036cde8a30f210279 Mon Sep 17 00:00:00 2001 From: Troy Prince Date: Wed, 7 Jul 2021 13:32:47 -0400 Subject: [PATCH 3/3] Updated readme, package.json to reflect inclusion of compodoc --- README.md | 6 +++++- projects/value-flash/package.json | 2 +- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ade94f4..f58d672 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,7 @@ This component is perfect for: ## Table of contents +- [Compodoc Documentation](#compodoc-documentation) - [Demo](#demo) - [Installation](#installation) - [Usage](#usage) @@ -36,6 +37,10 @@ This component is perfect for: - [License](#license) - [TODO](#TODO) +## Compodoc Documentation + +Full documentation, generated using [Compodoc](https://compodoc.app/): [https://lab49.github.io/angular-value-flash](https://lab49.github.io/angular-value-flash) + ## Demo Hosted Storybook demo: [https://main--60be66a91843f400393d1747.chromatic.com/](https://main--60be66a91843f400393d1747.chromatic.com/) @@ -137,7 +142,6 @@ These items are very high level right now. Further discussion and proper roadmap - [ ] Finanlize README.md (logo, coverage info). - [ ] Expand Storybook demos. - [ ] Expand unit tests. -- [ ] Publish compodoc documentation. ## Sponsored by Lab49 diff --git a/projects/value-flash/package.json b/projects/value-flash/package.json index 9802958..cb3c28a 100644 --- a/projects/value-flash/package.json +++ b/projects/value-flash/package.json @@ -7,7 +7,7 @@ "bugs": { "url": "https://github.com/lab49/angular-value-flash/issues" }, - "homepage": "https://github.com/lab49/angular-value-flash", + "homepage": "https://lab49.github.io/angular-value-flash", "keywords": [ "angular", "finance",