Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update contributing and templates #683

Merged
merged 1 commit into from
Jan 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,7 @@ If applicable, add screenshots to help explain your problem.

## Environment

- OS: [e.g. macOS, Windows, Ubuntu]
- Language [e.g. AssemblyScript, Go]
- Version [e.g. v0.xx]
Please run `modus info` and paste the output here.

## Additional context

Expand Down
31 changes: 14 additions & 17 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,20 @@ Please explain the changes you made here.

## Checklist

- [ ] Code compiles correctly and linting passes locally
- [ ] For all _code_ changes, an entry added to the `CHANGELOG.md` file describing and linking to
this PR
- [ ] Tests added for new functionality, or regression tests for bug fixes added as applicable
- [ ] For public APIs, new features, etc., PR on [docs repo](https://github.com/hypermodeinc/docs)
staged and linked here
All PRs should check the following boxes:

## Instructions
- [ ] I have given this PR a title using the
[Conventional Commits](https://www.conventionalcommits.org/) syntax, leading with `fix:`,
`feat:`, `chore:`, `ci:`, etc.
- The title should also be used for the commit message when the PR is squashed and merged.
- [ ] I have formatted and linted my code with Trunk, per the instructions in
[the contributing guide](https://github.com/hypermodeinc/modus/blob/main/CONTRIBUTING.md#trunk).

- The PR title should follow the [Conventional Commits](https://www.conventionalcommits.org/)
syntax, leading with `fix:`, `feat:`, `chore:`, `ci:`, etc.
- The description should briefly explain what the PR is about. In the case of a bugfix, describe or
link to the bug.
- In the checklist section, check the boxes in that are applicable, using `[x]` syntax.
- If not applicable, remove the entire line. Only leave the box unchecked if you intend to come
back and check the box later.
- Delete the `Instructions` line and everything below it, to indicate you have read and are
following these instructions. 🙂
If the PR includes a _code change_, then also check the following boxes. _(If not, then delete the
next section.)_

Thank you for your contribution to the Modus project!
- [ ] I have added an entry to the `CHANGELOG.md` file.
- Add to the "UNRELEASED" section at the top of the file, creating one if it doesn't yet exist.
- Be sure to include the link to this PR, and please sort the section numerically by PR number.
- [ ] I have manually tested the new or modified code, and it appears to behave correctly.
- [ ] I have added or updated unit tests where appropriate, if applicable.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,17 @@ The **Modus CLI** drives the local development experience and is written in Type
The fastest path to setting up a development environment for Modus is through VS Code. The repo
includes a set of configs to set VS Code up automatically.

#### Trunk

We use [Trunk](https://docs.trunk.io/) for linting and formatting. Please
[install the Trunk CLI](https://docs.trunk.io/cli/install) on your local development machine. You
can then use commands such as `trunk check` or `trunk fmt` for linting and formatting.

If you are using VS Code, you should also install the
[Trunk VS Code Extension](https://marketplace.visualstudio.com/items?itemName=trunk.io). The
workspace settings file included in this repo will automatically format and lint your code with
Trunk as you save your files, reducing or removing the need to use the Trunk CLI manually.

### Clone the Modus repository

To contribute code, start by forking the Modus repository. In the top-right of the
Expand Down