Skip to content

Commit

Permalink
feat(contribution): create contribution guideline (CONTRIBUTING.md)
Browse files Browse the repository at this point in the history
  • Loading branch information
dkorpos committed Jun 21, 2024
1 parent 3024565 commit 8a90351
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Contribution guideline

## Create a GitHub Pull Request

### 1. Fork the repository
### 2. Make changes, commit them to your fork
- As the release process is automated, write your commit message according to the [semantic-release documentation](https://github.com/semantic-release/semantic-release?tab=readme-ov-file#commit-message-format)'s default config
### 3. Push your changes to your fork
### 4. Create a pull request
- Go to https://github.com/emartech/escher-suiteapi-js/compare
- Select your fork and branch as head
- Select emartech/escher-suiteapi-js and master as base

Check warning on line 12 in CONTRIBUTING.md

View check run for this annotation

In Solidarity / Inclusive Language

Match Found

Please consider an alternative to `master`. Possibilities include: `primary`, `main`, `leader`, `active`, `writer`
Raw output
/\b(?!masterdata|masterdata\w+\b)master/gi
### 5. The code has to be approved and merged by a maintainer
- Ask the @js-maintainers user group on Slack for review

0 comments on commit 8a90351

Please sign in to comment.