Skip to content

Commit

Permalink
docs: add notes about pull request and validating changes (#427)
Browse files Browse the repository at this point in the history
  • Loading branch information
marcalexiei authored Jan 28, 2025
1 parent bbe9605 commit bf18ac0
Show file tree
Hide file tree
Showing 3 changed files with 90 additions and 8 deletions.
20 changes: 15 additions & 5 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,24 @@
## Context & Description
<!--
👋 Thank you for your Pull Request 🙏
-->

### Checklist

- [ ] I have read [Contributing > Pull requests](https://tuono.dev/documentation/contributing/pull-requests)

### Related issue

Fixes #0

<!-- Replace the content with "None" if you haven't an issue to link -->

### Overview

<!--
Thank you for your Pull Request.
Explain the context and why you're making that change.
What is the problem you're trying to solve?
If a new feature is being added,
describe the intended use case that feature fulfills.
Bug fixes and new features should include tests.
PR guide: https://tuono.dev/documentation/contributing/pull-requests
-->
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,54 @@ docker exec -it tuono-source-container /bin/bash
> On the documentation remember that `tuono` `npm` package is installed from the registry and
> it is not linked to the repository.
## Validate your changes

The following checks are all run on pull requests automatically.

You can also perform them locally.

## Formatting

For the typescript part you can run:

```sh
pnpm run format:check && pnpm run -w repo:root:format:check
```

For the rust codebase run:

```sh
cargo fmt
```

### Linting

For the typescript part you can run:

```sh
pnpm run lint
```

For the rust codebase run:

```sh
cargo clippy -- -D warnings
```

### Tests

For the typescript part you can run:

```sh
pnpm run test
```

For the rust codebase run:

```sh
cargo test
```

import NavigationButtons from '../../../components/NavigationButtons'

<NavigationButtons
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,22 @@ you can check the [official documentation](https://docs.github.com/en/pull-reque

---

- If you are fixing an issue, bear in mind to link the issue itself in the PR description.
- If you are adding a new feature, describe the intended use case that the feature fulfills.
- Please do:

> Bug fixes and new features should include tests.
- Fill the template in full

- If you are fixing an issue, bear in mind to link the issue itself in the PR description.
- If you are adding a new feature, describe the intended use case that the feature fulfills.

- Ensure your code is valid by running the test on you local machine.
Refer to ["Validate your changes" section](/documentation/contributing/local-development)

- Please **don't**:

- Do not use force push after marking the PR ready for review.

**Reasoning:** GitHub cannot track changes across force pushes,
which slows down our ability to perform incremental reviews.

## Title

Expand Down Expand Up @@ -76,6 +88,18 @@ E.g.: `fix(crates/tuono): remove cargo warnings`
A succinct title for the PR.
(The title max length is set to 100 characters)

## Addressing review feedback

Once we've reviewed your PR, we’ll provide feedback on any changes that need attention.
If you feel a suggested change isn’t correct, feel free to discuss it with us in the comments.

Please [post your comments](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-comments-to-a-pull-request)
as line comments when possible so they can be threaded.

After addressing all feedback, whether through code changes or by starting a follow-up discussion,
please [re-request a review](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews#re-requesting-a-review)
from each maintainer whose feedback you've addressed.

import NavigationButtons from '../../../components/NavigationButtons'

<NavigationButtons
Expand Down

0 comments on commit bf18ac0

Please sign in to comment.