diff --git a/.github/workflows/changelog-check.yml b/.github/workflows/changelog-check.yml index 3d1655b..75e9d23 100644 --- a/.github/workflows/changelog-check.yml +++ b/.github/workflows/changelog-check.yml @@ -4,6 +4,7 @@ on: types: [assigned, opened, synchronize, reopened, labeled, unlabeled] branches: - main + - develop jobs: build: name: Check Actions diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 2837f65..3b4c242 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -13,10 +13,10 @@ name: "CodeQL" on: push: - branches: [ main ] + branches: [ main, develop ] pull_request: # The branches below must be a subset of the branches above - branches: [ main ] + branches: [ main, develop ] schedule: - cron: '27 22 * * 1' diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 95796e5..badc122 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,6 +19,9 @@ Before submitting your contribution, please make sure to take a moment and read - The `main` branch is what is currently deployed to the website. All development should be done in dedicated branches. +- The `develop` branch contains the changes that will be deployed to main next. In order to prepare a release, development + branches should have their Pull Request against `develop` and only releases should be merged from `develop` into `main`. + - Work in the `src` folder and **DO NOT** checkin `dist` in the commits. - It's OK to have multiple small commits as you work on the PR - GitHub will automatically squash it before merging. @@ -30,6 +33,9 @@ Before submitting your contribution, please make sure to take a moment and read - If fixing a bug: - If you are resolving a special issue, add `(fix #xxxx[,#xxxx])` (#xxxx is the issue id) in your PR title for a better release log, e.g. `update entities encoding/decoding (fix #3899)`. - Provide a detailed description of the bug in the PR. Live demo preferred. + +- You'll need to update the `CHANGELOG.md` with a description of your changes before you open a pull request and your code + should pass the lint check. ## Development Setup