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.

Sign up for GitHub

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

Jump to bottom

Review doc #35

Merged
merged 9 commits into from
Oct 2, 2023
Merged

Review doc #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
5fffda2
Add upper case to tip
tmigot Oct 1, 2023
20c4d43
Fix typo in guideline
tmigot Oct 1, 2023
e2d44a9
Update developer.md
tmigot Oct 1, 2023
ccdb81c
Expand first time clone
tmigot Oct 1, 2023
36172fa
Review commit mess section
tmigot Oct 1, 2023
afc3a81
Update developer.md
tmigot Oct 1, 2023
de94977
Update developer.md
tmigot Oct 1, 2023
ecfa0da
Apply suggestions from code review
abelsiqueira Oct 1, 2023
ec9134a
Apply changes to template instead of the package directly
abelsiqueira Oct 2, 2023
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
2 changes: 1 addition & 1 deletion template/docs/src/contributing.md.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ If you found an issue that interests you, comment on that issue what your plans
If the solution to the issue is clear, you can immediately create a pull request (see below).
Otherwise, say what your proposed solution is and wait for a discussion around it.

> **tip**
> **Tip**
>
> Feel free to ping us after a few days if there are no responses.

Expand Down
20 changes: 13 additions & 7 deletions template/docs/src/developer.md.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Developer documentation

If you haven't, please read the [Contributing guidelindes](contributing.md) first.
If you haven't, please read the [Contributing guidelines](contributing.md) first.

## Linting and formatting

Expand All @@ -10,7 +10,7 @@ This will ensure that your editor is configured with important formatting settin
We use [https://pre-commit.com](https://pre-commit.com) to run the linters and formatters.
In particular, the Julia code is formatted using [JuliaFormatter.jl](https://github.com/domluna/JuliaFormatter.jl), so please install it globally first.

Install `pre-commit` (we recommend using [pipx](https://pypa.github.io/pipx/)):
To install `pre-commit`, we recommend using [pipx](https://pypa.github.io/pipx/) as follows:

```bash
# Install pipx following the link
Expand All @@ -33,9 +33,15 @@ pre-commit run -a

## First time clone

If this is the first time you work with this repository, follow the instructions below to clone the repository.

1. Fork this repo
2. Clone your repo (this will create a `git remote` called `origin`)
3. Add this repo as a remote `git remote add orgremote https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl`
3. Add this repo as a remote:

```bash
git remote add orgremote https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl
```

## Working on a new issue

Expand Down Expand Up @@ -70,9 +76,9 @@ pre-commit run -a

### Commit message

- Use imperative, present tense (Add feature, Fix bug)
- Have informative titles
- If necessary, add a body with details
- Use imperative or present tense, for instance: *Add feature* or *Fix bug*.
- Have informative titles.
- If necessary, add a body with details.

### Before creating a pull request

Expand All @@ -86,4 +92,4 @@ pre-commit run -a
git rebase orgremote/main BRANCH_NAME
```

- Then you can open a pull request and work with the reviewer to address any issues
- Then you can open a pull request and work with the reviewer to address any issues.
Loading