Skip to content

Commit

Permalink
feat: test
Browse files Browse the repository at this point in the history
  • Loading branch information
stas-nc committed Oct 24, 2024
1 parent 2ad17b3 commit e66f419
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 27 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: CI
on:
push:
branches:
- master
- '**'
tags-ignore:
- '**'
pull_request:
Expand Down Expand Up @@ -46,7 +46,7 @@ jobs:
needs: build
runs-on: ubuntu-latest
environment: npm_publish
if: github.ref == 'refs/heads/master'
# if: github.ref == 'refs/heads/master'
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
Expand All @@ -58,4 +58,4 @@ jobs:
env:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: npx semantic-release
run: npx semantic-release --dry-run
46 changes: 22 additions & 24 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,49 +4,47 @@

There are multiple ways of getting involved:

- [Report a bug](#report-a-bug)
- [Suggest a feature](#suggest-a-feature)
- [Contribute code](#contribute-code)
- [Report a bug](#report-a-bug)
- [Suggest a feature](#suggest-a-feature)
- [Contribute code](#contribute-code)

Below are a few guidelines we would like you to follow.
If you need help, please reach out to one or more of the maintainers.

## Report a bug
## Report a bug

Reporting bugs is one of the best ways to contribute. Before creating a bug report, please check that an issue reporting the same problem does not already exist. If there is an such an issue, you may add your information as a comment.

To report a new bug you should open an issue that summarizes the bug and set the label to "bug".

If you want to provide a fix along with your bug report: That is great! In this case please send us a pull request as described in section [Contribute Code] (#contribute-code).

## Suggest a feature
To request a new feature you should open a GitHub issue and summarize the desired functionality and its use case. Set the issue label to "feature".

To request a new feature you should open a GitHub issue and summarize the desired functionality and its use case. Set the issue label to "feature".

## Contribute code

This is a rough outline of what the workflow for code contributions looks like:
- Check the list of open issues at GitHub. Either assign an existing issue to yourself, or create a new one that you would like work on and discuss your ideas and use cases.
- Fork the repository on GitHub
- Create a topic branch from where you want to base your work. This is usually master.
- Make commits of logical units.
- Write good commit messages (see below).
- Push your changes to a topic branch in your fork of the repository.
- Submit a pull request
- Your pull request must receive a :thumbsup: from two maintainers

- Check the list of open issues at GitHub. Either assign an existing issue to yourself, or create a new one that you would like work on and discuss your ideas and use cases.
- Fork the repository on GitHub
- Create a topic branch from where you want to base your work. This is usually master.
- Make commits of logical units.
- Write good commit messages (see below).
- Push your changes to a topic branch in your fork of the repository.
- Submit a pull request
- Your pull request must receive a :thumbsup: from two maintainers

Thanks for your contributions!

### Commit messages
Your commit messages ideally can answer two questions: what changed and why. The subject line should feature the “what” and the body of the commit should describe the “why”.

Your commit messages ideally can answer two questions: what changed and why. The subject line should feature the “what” and the body of the commit should describe the “why”.

When creating a pull request, its comment should reference the corresponding issue id.

**Have fun and enjoy hacking!**
Commit mesage format must follow [Conventional Commits
spec](https://www.conventionalcommits.org/en/v1.0.0/)

## New version release
To release new version of package use the following steps:
```
$ npx -p conventional-changelog-angular -p conventional-changelog-preset-loader -p conventional-recommended-bump conventional-recommended-bump --preset angular
$ npm version [major | minor | patch]
# Review last commit
$ git push && git push --tags
$ npm publish
```
**Have fun and enjoy hacking!**

0 comments on commit e66f419

Please sign in to comment.