clevermicro/user-management
14
0
Fork 0
Code Issues 6 Pull Requests Actions Packages Projects Releases Wiki Activity

Initial commit

Browse Source
This commit is contained in:
Jeffrey Phillips Freeman
2024-01-25 23:06:27 -05:00
commit 635b100322
11 changed files with 291 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.cz-config.js
+48
View File
@@ -0,0 +1,48 @@
'use strict';
module.exports = {
types: [
{value: 'feat', name: 'feat: A new feature'},
{value: 'fix', name: 'fix: A bug fix'},
{value: 'docs', name: 'docs: Documentation only changes'},
{value: 'style', name: 'style: Changes that do not affect the meaning of the code\n (white-space, formatting, etc)'},
{value: 'refactor', name: 'refactor: A code change that neither fixes a bug nor adds a feature'},
{value: 'perf', name: 'perf: A code change that improves performance'},
{value: 'test', name: 'test: Adding missing tests or correcting existing tests'},
{value: 'build', name: 'build: Changes that affect the build system or external dependencies (example scopes: maven, gradle, npm, gulp)'},
{value: 'ci', name: 'ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)'},
{value: 'chore', name: 'chore: Other changes that dont modify src or test files'},
{value: 'revert', name: 'revert: Reverts a previous commit'}
],
scopes: [
{name: 'General'}
],
scopeOverrides: {
build: [
{name: 'dependencies'},
{name: 'versioning'},
{name: 'release'},
{name: 'build plugin'}
],
ci: [
{name: 'travis'}
],
chore: [
{name: 'commitizen'},
{name: 'editorconfig'},
{name: 'git'}
],
docs: [
{name: 'source'},
{name: 'repo'},
{name: 'build'}
]
},
allowCustomScopes: true,
allowBreakingChanges: ['feat', 'fix', 'docs', 'style', 'refactor', 'perf', 'test', 'build', 'ci', 'chore', 'revert']
};
.cz.json
+1
View File
@@ -0,0 +1 @@
{ "path": "cz-customizable" }
.editorconfig
+14
View File
@@ -0,0 +1,14 @@
# top-most EditorConfig file
root = true
[*]
#unix style line ending
end_of_line = lf
#newline at end of file
insert_final_newline = true
#charset UTF-8
charset = utf-8
#indent using spaces
indent_style = space
#4 spaces per indent
indent_size = 4
.gitattributes
+4
View File
@@ -0,0 +1,4 @@
* eol=lf
*.bat eol=crlf
*.sh eol=lf
.git* export-ignore
.gitignore
+50
View File
@@ -0,0 +1,50 @@
# Useful examples
# https://github.com/github/gitignore
# OS X
*.DS_Store
# Java
*.jar
*.war
*.ear
# C/C++
*.so
*.dylib
*.dSYM
*.dll
*.jnilib
# Mobile Tools for Java (J2ME)
.mtj.tmp/
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
hs_err_pid*
# Directories
**/bin/
**/classes/
**/dist/
**/include/
**/nbproject/
/.libs/
/findbugs/
/target/
#intellij
.idea/
*.iml
#logs
*.log
#project specific
/src/genjava
#Eclipse che
.che/
.classpath
.project
.settings/
ATTRIBUTIONS.md
+9
View File
@@ -0,0 +1,9 @@
This file contains all attributions and other notices that are required by law. This will contain all copyright
notices as well as any notes regarding licensing.
## Copyright Notices
The following are the list of all recognized copyright notices added by contributors to this project:
Copyright (c) 2016 - present, Syncleus, Inc. All rights reserved.
Copyright (c) 2024 - presend, CleverThis, Inc. All rights reserved.
CHANGELOG.md
+4
View File
@@ -0,0 +1,4 @@
# Changelog
## v0.0.1
* Initial release.
CODE_OF_CONDUCT.md
+72
View File
@@ -0,0 +1,72 @@
# 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, gender identity and expression, level of experience,
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:
* Unwelcomed sexual attention or advances.
* Derogatory comments about a persons appearance, race, or sexual orientation.
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
## 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 project team at
[abuse@cleverthis.com](mailto:abuse@cleverthis.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 [http://contributor-covenant.org/version/1/4][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
CONTRIBUTING.md
+64
View File
@@ -0,0 +1,64 @@
# Contributing
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
[![Semantic Versioning](https://img.shields.io/SemVer/2.0.0.png)](http://semver.org/spec/v2.0.0.html)
[![Matrix](https://img.shields.io/matrix/cleverthis%3Aqoto.org?server_fqdn=matrix.qoto.org&label=Matrix%20chat)](https://matrix.to/#/#CleverThis:qoto.org)
When contributing to this repository, it is usually a good idea to first discuss the change you
wish to make via issue, email, or any other method with the owners of this repository before
making a change. This could potentially save a lot of wasted hours.
Please note we have a code of conduct, please follow it in all your interactions with the project.
## Development
### Commit Message Format
All commits on this repository must follow the
[Conventional Changelog standard](https://github.com/conventional-changelog/conventional-changelog-eslint/blob/master/convention.md).
It is a very simple format so you can still write commit messages by hand. However it is
highly recommended developers install [Commitizen](https://commitizen.github.io/cz-cli/),
it extends the git command and will make writing commit messages a breeze. All CleverThis
repositories are configured with local Commitizen configuration scripts.
Getting Commitizen installed is usually trivial, just install it via npm. You will also
need to install the cz-customizable adapter which CleverThis repositories are configured
to use.
```bash
npm install -g commitizen@2.8.6 cz-customizable@4.0.0
```
Below is an example of Commitizen in action. It replaces your usual `git commit` command
with `git cz` instead. The new command takes all the same arguments however it leads you
through an interactive process to generate the commit message.
![Commitizen friendly](https://docs.cleverthis.com/public_media/commitizen.gif)
Commit messages are used to automatically generate our changelogs, and to ensure
commits are searchable in a useful way. So please use the Commitizen tool and adhere to
the commit message standard or else we cannot accept Pull Requests without editing
them first.
Below is an example of a properly formated commit message.
```
chore(Commitizen): Made repository Commitizen friendly.
Added standard Commitizen configuration files to the repo along with all the custom rules.
ISSUES CLOSED: #31
```
### Pull Request Process
1. Ensure that install or build dependencies do not appear in any commits in your code branch.
2. Ensure all commit messages follow the [Conventional Changelog](https://github.com/conventional-changelog/conventional-changelog-eslint/blob/master/convention.md)
standard explained earlier.
3. Update the CONTRIBUTORS.md file to add your name to it if it isn't already there (one entry
per person).
4. Adjust the project version to the new version that this Pull Request would represent. The
versioning scheme we use is [Semantic Versioning](http://semver.org/).
5. Your pull request will either be approved or feedback will be given on what needs to be
fixed to get approval. We usually review and comment on Pull Requests within 48 hours.
CONTRIBUTORS.md
+10
View File
@@ -0,0 +1,10 @@
# Contributors
* Jeffrey Phillips Freeman <jeffrey.freeman@syncleus.com>
# Details
Below are some of the specific details of various contributions.
* Jeffrey Phillips Freeman has acted as Lead Developer, daily contributor, and Project Owner.
* This project was made possible thanks to considerable donation of time, money, and resources by CleverThis, Inc.
README.md
+15
View File
@@ -0,0 +1,15 @@
![CleverThis](https://docs.cleverthis.com/public_media/logo-transp.png)
[![pipeline status](https://git.cleverthis.com/cleverthis/base/root/badges/master/pipeline.svg)](https://git.cleverthis.com/cleverthis/base/root/-/commits/master)
[![coverage report](https://git.cleverthis.com/cleverthis/base/root/badges/master/coverage.svg)](https://git.cleverthis.com/cleverthis/base/root/-/commits/master)
[![SemVer](https://img.shields.io/badge/SemVer-v2.0.0-green)](https://semver.org/spec/v2.0.0.html)
[![Matrix](https://img.shields.io/matrix/cleverthis%3Aqoto.org?server_fqdn=matrix.qoto.org&label=Matrix%20chat)](https://matrix.to/#/#CleverThis:qoto.org)
This is a starter project to be used as a starting point for new projects.
## Donating
[![Open Collective backers](https://img.shields.io/opencollective/all/CleverThis)](https://opencollective.com/cleverthis)
As an open-source project we run entierly off donations. Buy one of our hardworking developers a beer by [donating at OpenCollective](https://opencollective.com/cleverthis). All donations go to our bounty fund and allow us to place bounties on important bugs and enhancements. You may also use Beerpay linked via the above badges.