Skip to content

Commit

Permalink
Merge pull request #2 from TomokiMiyauci/beta
Browse files Browse the repository at this point in the history
Beta
  • Loading branch information
TomokiMiyauci committed Jul 7, 2023
2 parents ca7747a + fb5c259 commit 13e529a
Show file tree
Hide file tree
Showing 31 changed files with 1,404 additions and 607 deletions.
129 changes: 129 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible 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.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of
any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address,
without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders 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, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
<contact@miyauci.dev>. All complaints will be reviewed and investigated promptly
and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.

Community Impact Guidelines were inspired by
[Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
<https://www.contributor-covenant.org/faq>. Translations are available at
<https://www.contributor-covenant.org/translations>.
11 changes: 11 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Security Policy

## Supported Versions

| Version | Supported |
| :-----: | :----------------: |
| 2.y.z | :white_check_mark: |

## Reporting a Vulnerability

Please report to <contact@miyauchi.dev> regarding the vulnerability.
25 changes: 25 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,28 @@
# [2.0.0-beta.2](https://github.com/TomokiMiyauci/result-js/compare/2.0.0-beta.1...2.0.0-beta.2) (2023-07-07)


### Features

* **transform:** add mapOr transform operator ([d969bd9](https://github.com/TomokiMiyauci/result-js/commit/d969bd9c602e75e12769ddda3b13d2aaa54ea717))

# [2.0.0-beta.1](https://github.com/TomokiMiyauci/result-js/compare/1.0.0...2.0.0-beta.1) (2023-07-07)


### Features

* **extract:** add extract operators ([497626f](https://github.com/TomokiMiyauci/result-js/commit/497626fc11ca6a2db4d10fc03f0b90fc4b4c4825))
* **logical:** add logical operators ([a159d31](https://github.com/TomokiMiyauci/result-js/commit/a159d31654ef33c2e21a5b42b63e17968f26e3f4))
* **mod:** export related modules ([e033f82](https://github.com/TomokiMiyauci/result-js/commit/e033f82713df356d3b9d8dffc69de424051a22e4))
* **mod:** remove all API ([0919773](https://github.com/TomokiMiyauci/result-js/commit/0919773137c0a7cf9c6270b5ed5bc34cf4b1ccb5))
* **query:** add query operators ([8ced6fd](https://github.com/TomokiMiyauci/result-js/commit/8ced6fd3fa099a52fef2a99757a3a2097c377eae))
* **spec:** add specification interface and type constructor ([1dfcc9a](https://github.com/TomokiMiyauci/result-js/commit/1dfcc9a4c6756c8d4fa1e93bad0b87b4be012a30))
* **transform:** add transform operator ([9bb241b](https://github.com/TomokiMiyauci/result-js/commit/9bb241bf639958d172a655a82dd9f247d2a58330))


### BREAKING CHANGES

* **mod:** remove all API

# 1.0.0 (2022-09-30)

### Bug Fixes
Expand Down
138 changes: 138 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
# Contributing

We welcome and appreciate all contributions.

We follow the [code of conduct](./.github/CODE_OF_CONDUCT.md).

## Submitting a pull request

Before submitting a PR to any of the repos, please make sure the following is
done:

1. Give the PR a descriptive title
2. Run [fmt](#format) in the root of repository
3. Run [lint](#lint)
4. Run [test](#test)

## Coding rules

We follow the
[style guide](https://deno.com/manual/references/contributing/style_guide).

### Source code

To ensure consistency and quality throughout the source code, all code
modifications must have:

- No [linting](#lint) errors
- A [test](#test) for every possible case introduced by your code change
- 100% test coverage
- [Valid commit message](#commit-message-guidelines)

### Format

This will format all of the code to adhere to the consistent style in the
repository.

```bash
deno fmt
```

### Lint

This will check TypeScript code for common mistakes and errors.

```bash
deno lint
```

### Test

This will run all logic test and document test.

```bash
deno test --import-map=./_test_import_map.json --doc
```

or

```bash
deno task test
```

### Commit message guidelines

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**:

```commit
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
```

The **header** is mandatory and the **scope** of the header is optional.

The **footer** can contain a
[closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages).

#### Type

The type must be one of the following:

| Type | Description |
| ------------ | ------------------------------------------------------------------------------------------------------ |
| **build** | Changes that affect the build system or external dependencies |
| **ci** | Changes to our CI configuration files and scripts |
| **docs** | Documentation only changes |
| **feat** | A new feature |
| **fix** | A bug fix |
| **perf** | A code change that improves performance |
| **refactor** | A code change that neither fixes a bug nor adds a feature |
| **style** | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
| **test** | Adding missing tests or correcting existing tests |

#### Subject

The subject contains succinct description of the change:

- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize first letter
- no dot (.) at the end

#### Body

Just as in the **subject**, use the imperative, present tense: "change" not
"changed" nor "changes". The body should include the motivation for the change
and contrast this with previous behavior.

#### Footer

The footer should contain any information about **Breaking Changes** and is also
the place to reference GitHub issues that this commit **Closes**.

**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space
or two newlines. The rest of the commit message is then used for this.

#### Examples

```commit
fix(pencil): stop graphite breaking when too much pressure applied
```

```commit
feat(pencil): add 'graphiteWidth' option
Fix #42
```

```commit
perf(pencil): remove graphiteWidth option
BREAKING CHANGE: The graphiteWidth option has been removed.
The default graphite width of 10mm is always used for performance reasons.
```
Loading

0 comments on commit 13e529a

Please sign in to comment.