Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

0.9.0 #30

Merged
merged 5 commits into from
Sep 26, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 8 additions & 0 deletions .eggignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
extends .gitignore
.*ignore

# Extra typescript files
test/
*_test.ts
Drakefile.ts

74 changes: 74 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
## 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 behaviour 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 behaviour by participants include:

- The use of sexualised 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
behaviour and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behaviour.

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 behaviour may be
reported by contacting the project team at support@nest.land. 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/
62 changes: 62 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
<p align="center">
<img alt="GitHub issues" src="https://img.shields.io/github/issues-raw/nestdotland/eggs?logo=github">
<img alt="GitHub closed issues" src="https://img.shields.io/github/issues-closed-raw/nestdotland/eggs?logo=github">
<img alt="GitHub contributors" src="https://img.shields.io/github/contributors/nestdotland/eggs">
</p>
<p align="center">
<a href="https://deno.land"><img src="https://img.shields.io/badge/-deno-gray?logo=deno" alt="Runtime"></a>
<a href="https://www.typescriptlang.org/"><img src="https://img.shields.io/badge/-typescript-blue?logo=typescript" alt="language"></a>
</p>

# Contributing / Developing

Contributions are welcome. Fork this repository and issue a pull request with your changes.

Please add new tests for new functionality, adapt the existing ones if needed, and make sure that `deno test` succeeds.

### Prerequisites
You need to have [Git](https://git-scm.com/downloads) and [deno](https://deno.land) installed on your system.

### Setting up Dev
Just execute these commands:

```shell
git clone https://github.com/nestdotland/eggs.git
cd eggs/
```

This project uses drake to manage project scripts. Run it with Deno:
```sh
deno run -A Drakefile.ts
# A shell alias shortcut can be set to run the default drakefile:
alias drake="deno run -A Drakefile.ts"
```

### Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [link to tags on this repository](/tags).

### Tests

```sh
drake test
```

### Style guide

```sh
drake format
drake lint
```

Make sure to use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).

### Pull request

**Please PR to the `dev` branch!**
Then follow the [pull request template](.github/PULL_REQUEST_TEMPLATE/pull_request.md).

### Deploying / Publishing

Submit a pull request after running `drake dev` to ensure it runs correctly.
The module is automatically published to nest.land when a new release is published on github.
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
name: 🐛 Bug Report
about: Submit a bug report to help us improve
labels: 'type: bug, status: needs triage'
---

<!--

🚨 What happens if you delete this entire template and go your own path

Someone will read your bug report, and maybe will be able to help you,
but it’s unlikely that it will get much attention from the team. Eventually,
the issue will likely get closed in favor of issues that have this template.
Please provide all the info requested in this template.

Please remember that:

* The person fixing the bug would have to figure out these details anyway. Please be respectful of their time.
* You might figure out the issues yourself as you work on extracting these details.
* If you list multiple bugs/concerns in this one issue, it makes it hrd to track the progress.
* If you open an issue that has many duplicates, the triager may close your issue.
* If yuo file something completely blank in the body, the triager may close your issue without further explanation or engagement.

-->

## 🐛 Bug Report

<!-- A clear and concise description of what the bug is -->

## To Reproduce

<!-- Write your steps here -->

1. Step 1...
2. Step 2...
3. Step 3...

## Expected behavior

<!--
How did you expect your project to behave?
It’s fine if you’re not sure your understanding is correct.
Write down what you thought would happen.
-->

## Actual Behavior

<!--
Did something go wrong?
Is something broken, or not behaving as you expected?
Describe this section in detail, and attach screenshots if possible.
Don't only say "it doesn't work"!
-->

## Environment

<!-- Include as many relevant details about the environment you experienced the bug in -->

- Eggs version:
- Deno version:
- Operating system and version:

## Additional context

<!-- Any aditional information that may help us solve this issue -->

<!-- Thanks for helping us help you!-->
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: 📚 Documentation Issue
about: Report an issue related to documentation
labels: 'meta: documentation, status: needs triage'
---

## 📚 Documentation Issue

<!-- A clear and concise description of what the issue is. -->
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: 🚀 Feature Request/Idea
about: Suggest a feature or idea for this project
labels: 'type: feature, status: needs triage'
---

<!--

🚨 What happens if you delete this entire template and go your own path?

Someone will read your feature proposal and maybe will be able to help you,
but it’s unlikely that it will get much attention from the team. Eventually,
the issue will likely get closed in favor of issues that have better explanations

-->

## 🚀 Feature

<!-- A clear and concise description of what the feature is. -->

## Motivation

<!-- Please outline the motivation for the proposal. -->

## Implementation

<!-- Please explain why this feature should be implemented and how it would be used. -->

## Alternatives

<!-- Any alternative solutions or features that you've considered. -->

## Additional context

<!-- Add any other context or screenshots about the feature request. -->

<!-- Thanks for helping us help you! -->
39 changes: 39 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
<!-- Make sure you have read the contribution guide!
https://github.com/nestdotland/template/tree/master/.github/CONTRIBUTING.md
-->

# Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

## Type of change

Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

# How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

- [ ] Test A
- [ ] Test B

**Test Configuration**:
* OS:
* Version:

# Checklist:

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
15 changes: 9 additions & 6 deletions .github/release-template.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,16 @@ version-resolver:
default: patch

template: |

## CHANGELOG

$CHANGES

## Import

```js
import * as hatcher from "https://x.nest.land/hatcher@$RESOLVED_VERSION/mod.ts"

### Install / Upgrade

**Using Deno**

```sh
deno install -Afq https://x.nest.land/hatcher@$RESOLVED_VERSION/hatcher.ts
```

Special thanks to $CONTRIBUTORS for their contributions to this release!
10 changes: 8 additions & 2 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,11 @@ jobs:
- name: Setup Deno
uses: denolib/setup-deno@v2

- name: Setup Drake
run: deno run -A Drakefile.ts setup-github-actions

- name: Check formatting
run: deno fmt --check
run: drake check-format

lint:
name: deno lint
Expand All @@ -31,6 +34,9 @@ jobs:

- name: Setup Deno
uses: denolib/setup-deno@v2

- name: Setup Drake
run: deno run -A Drakefile.ts setup-github-actions

- name: Run linter
run: deno lint --unstable
run: drake lint
16 changes: 10 additions & 6 deletions .github/workflows/ship.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,21 @@ jobs:

- name: Setup Deno
uses: denolib/setup-deno@v2
with:
deno-version: v1.3.3

- name: Publish hatcher
run: |
deno run -A --unstable https://x.nest.land/eggs@0.2.1/mod.ts link ${{ secrets.NESTAPIKEY }}
deno run -A --unstable https://x.nest.land/eggs@0.2.1/mod.ts publish
- name: Setup Drake
run: deno run -A Drakefile.ts setup-github-actions

- name: Get hatcher version
run: drake get-version

- name: Draft release
id: draft_release
uses: release-drafter/release-drafter@v5
with:
config-name: release-template.yml
version: ${{ env.HATCHER_VERSION }}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Publish hatcher
run: drake ship