Skip to content

Commit

Permalink
v1.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
shuritch committed Mar 19, 2024
1 parent 8c8f97e commit 467192e
Show file tree
Hide file tree
Showing 6 changed files with 584 additions and 917 deletions.
10 changes: 9 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
<!--
Thank you for your pull request.
Check following steps to help us land your changes:
Change [ ] to [x] for completed items.
- Fill current date
- Create list with pull request changes / or describe purpose of pull request
- Change [ ] to [x] for completed items.
-->

## Changes - 202x-xx-xx

- Added ...
- Updated ...
- Deleted ...

- [ ] tests and linter show no problems (`npm t`)
- [ ] tests are added/updated for bug fixes and new features
- [ ] code is properly formatted (`npm run fmt`)
Expand Down
39 changes: 0 additions & 39 deletions .github/workflows/cd.example

This file was deleted.

7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

## [Unreleased][unreleased]

## [1.5.0][] - 2024-03-19

- Packages update
- Eslint bug fix
- Pull request template update
- README update

## [1.4.0][] - 2024-03-18

- Packages update
Expand Down
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@

### First step: workspace installation

Use next commands to install and update your workspace Or use this repository as a template
repository, if so - you can skip this step.
You can use this repository as template - otherwise install it manually:

```bash
# Download repository
Expand All @@ -15,15 +14,18 @@ repository, if so - you can skip this step.
# Update and install dependencies
ncu -u
npm i
# Update node.js (optional()
# Update node.js (optional)
nvm install latest
nvm use latest
```

### Second step: Package personalization

Update package json, all with prefix <code>your-</code><br/> If your nodejs version newer than
package.json current add <code>|| your-node-version</code>.
Update package json:

- Replace all fields with prefix <code>your-</code>
- Update engines, if current is out of date
- Remove browser field & dist folder, if you don't support it

```js
// package.json
Expand Down Expand Up @@ -70,7 +72,7 @@ package.json current add <code>|| your-node-version</code>.

### Third step: About files

Go to CHANGELOG.md and update it for your package. _WARNING !_ Don't fotget about date (xxxx-xx-xx).
Go to CHANGELOG.md and update it for your package. _WARNING !_ Don't forget about date (xxxx-xx-xx).

```md
<!-- CHANGELOG.md -->
Expand Down Expand Up @@ -110,8 +112,8 @@ Replace your README.md with next information and change Your-package-name to act

<p align="center">
Copyright © 2023 <a href="https://github.com/astrohelm/Your-package-name/graphs/contributors">Astrohelm contributors</a>.
Your-package-name is <a href="./LICENSE">MIT licensed</a>.<br/>
Your-package-name is part of <a href="https://github.com/astrohelm">Astrohelm ecosystem</a>.
This repository is <a href="./LICENSE">MIT licensed</a>.<br/>
And it is part of <a href="https://github.com/astrohelm">Astrohelm ecosystem</a>.
</p>
```

Expand Down Expand Up @@ -141,7 +143,7 @@ Return to your organization repository and do:
- Update description
- Draft release with `v0.0.1` tag and `v0.0.1` as a title and updated README file as description.

> If you creating library you may publish it now to npm with `npm publish` command.
> If you want to create library you could publish it to npm with `npm publish` command.
Congratulations, package initialized 🚀

Expand Down
Loading

0 comments on commit 467192e

Please sign in to comment.