Skip to content

Commit

Permalink
Merge branch 'dev' into yuhsuan/stores_null_check
Browse files Browse the repository at this point in the history
  • Loading branch information
YuHsuan-Hwang committed May 2, 2024
2 parents 984fb6c + bf5a5dc commit 0951020
Show file tree
Hide file tree
Showing 10 changed files with 932 additions and 293 deletions.
7 changes: 2 additions & 5 deletions .github/PULL_REQUEST_TEMPLATE/version_bump_template.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
**Description**

This PR is for the release version bump, the final step before tagging a beta release or creating a stable release branch.
This PR is for the version bump, the final step before tagging a release on a release branch, or the first step when starting a new dev cycle.

**Checklist**

- [ ] `package.json` version string updated
- [ ] `package-lock.json` version string updated (by running `npm install`)
- [ ] changelog version string updated
- [ ] user manual URL in the about dialog updated (for stable releases)

**Note**

The documentation website requires an update (following the [guidelines](https://cartavis.org/carta-frontend/docs/contributing/documentation-guidelines#versioning)) after the beta release is tagged or the stable release branch is created.
- [ ] documentation website updated (for start of new cycle, on the dev branch after a release is tagged) ([guidelines](https://cartavis.org/carta-frontend/docs/contributing/documentation-guidelines#versioning))
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ linked issues and companion PRs (if there are), what is implemented or fixed, ho

For linked issues (if there are):
- [ ] assignee and label added
- [ ] ZenHub issue connection, board status, and estimate updated
- [ ] GitHub Project estimate added

For the pull request:
- [ ] reviewers and assignee added
- [ ] ZenHub estimate, milestone, and release (if needed) added
- [ ] GitHub Project estimate added
- [ ] changelog updated / no changelog update needed
- [ ] unit test added (for functions with no dependenies)
- [ ] API documentation added (for public variables and methods in stores)
Expand Down
2 changes: 1 addition & 1 deletion docs_website/docs/contributing/documentation-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Guidelines for building and writing this website.

## Building documentation

The website is hosted on Github Pages, and whenever the `dev` branch is updated, the website is automatically updated using Github Actions.
The website is hosted on GitHub Pages, and whenever the `dev` branch is updated, the website is automatically updated using GitHub Actions.

To build and test the website locally, navigate to the `docs_website/` directory and install package dependencies:

Expand Down
8 changes: 4 additions & 4 deletions docs_website/docs/contributing/github-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 2
---

# Github workflow
# GitHub workflow

The workflow for contributing to the codebase.

Expand Down Expand Up @@ -32,7 +32,7 @@ Before making any changes to the codebase, create and check out to a new branch.
git checkout -b "[author]/[issue id]_[description_with_underscores]"
```

If the issue doesn't exist yet, please create a new issue. When you start working on the issue, update the ZenHub status of the issue to "In Progress".
If the issue doesn't exist yet, please create a new issue. When you start working on the issue, update the GitHub Project status of the issue to "In Progress".

### Pushing changes

Expand Down Expand Up @@ -63,13 +63,13 @@ For linked issues (if there are): this section is for checking the status of the

- assignee and label added: assign yourself to the issue you are working on. Add labels to the issue.

- ZenHub issue connection, board status, and estimate updated: connect the issue to the pull request in ZenHub. ZenHub automatically updates the issue status from "In Progress" to "Review/QA" by default. Also, provide an estimate for the time required to complete the issue. This estimation is useful for future development planning.
- GitHub Project estimate added: provide an estimate for the time required to complete the issue. This estimation is useful for future development planning.

For the pull request: this section is for checking the status of the pull request and reviewing the code changes.

- reviewers and assignee added: assign reviewers and an assignee to the pull request. The assignee will be responsible for merging the pull request.

- ZenHub estimate, milestone, and release (if needed) added: provide an estimate for the time required to review the pull request.
- GitHub Project estimate added: provide an estimate for the time required to review the pull request.

- changelog updated / no changelog update needed: updating the changelog is required when the issue exists in the latest release and the changes have an impact on users. It is recommended to update the changelog when sending the pull request and to resolve changelog merge conflicts using the GitHub UI.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Guidelines for building and writing this website.

## Building documentation

The website is hosted on Github Pages, and whenever the `dev` branch is updated, the website is automatically updated using Github Actions.
The website is hosted on GitHub Pages, and whenever the `dev` branch is updated, the website is automatically updated using GitHub Actions.

To build and test the website locally, navigate to the `docs_website/` directory and install package dependencies:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 2
---

# Github workflow
# GitHub workflow

The workflow for contributing to the codebase.

Expand Down Expand Up @@ -32,7 +32,7 @@ Before making any changes to the codebase, create and check out to a new branch.
git checkout -b "[author]/[issue id]_[description_with_underscores]"
```

If the issue doesn't exist yet, please create a new issue. When you start working on the issue, update the ZenHub status of the issue to "In Progress".
If the issue doesn't exist yet, please create a new issue. When you start working on the issue, update the GitHub Project status of the issue to "In Progress".

### Pushing changes

Expand Down Expand Up @@ -63,13 +63,13 @@ For linked issues (if there are): this section is for checking the status of the

- assignee and label added: assign yourself to the issue you are working on. Add labels to the issue.

- ZenHub issue connection, board status, and estimate updated: connect the issue to the pull request in ZenHub. ZenHub automatically updates the issue status from "In Progress" to "Review/QA" by default. Also, provide an estimate for the time required to complete the issue. This estimation is useful for future development planning.
- GitHub Project estimate added: provide an estimate for the time required to complete the issue. This estimation is useful for future development planning.

For the pull request: this section is for checking the status of the pull request and reviewing the code changes.

- reviewers and assignee added: assign reviewers and an assignee to the pull request. The assignee will be responsible for merging the pull request.

- ZenHub estimate, milestone, and release (if needed) added: provide an estimate for the time required to review the pull request.
- GitHub Project estimate added: provide an estimate for the time required to review the pull request.

- changelog updated / no changelog update needed: updating the changelog is required when the issue exists in the latest release and the changes have an impact on users. It is recommended to update the changelog when sending the pull request and to resolve changelog merge conflicts using the GitHub UI.

Expand Down

0 comments on commit 0951020

Please sign in to comment.