Skip to content

Commit

Permalink
feat: updated markdown files
Browse files Browse the repository at this point in the history
  • Loading branch information
AlejandroSuero committed May 6, 2024
1 parent 6f373b9 commit e001352
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,6 @@ return {
```

> [!note]
>
> See default configuration.
## Default configuration
Expand Down
15 changes: 9 additions & 6 deletions contrib/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,20 +29,23 @@ This project uses [selene](https://github.com/Kampfkarren/selene) as the linter,
using `git switch -c <branch-name>`.

- **Make your changes**: Implement your changes on your local machine. Make sure
to follow the project standards (linting and formatting rules).
to follow the project standards (linting and formatting rules).

> [!note]
> You can use `make lint` and `make test` to check if your changes are correct
3. **Send your changes**

- **Commit your changes**: Once you are satisfied with your changes, commit them
with a descriptive and concise message. Following the standards is recommended,
[conventional commit messages](https://www.conventionalcommits.org/en/v1.0.0).
with a descriptive and concise message. Following the standards is recommended,
[conventional commit messages](https://www.conventionalcommits.org/en/v1.0.0).

- **Push to your fork**: Push your changes to your fork using
`git push origin <branch-name>`.
`git push origin <branch-name>`.

- **Create a Pull Request (PR)**: Once you pushed your changes, make a pull request
so we can see the changes and discuss over it if necessary. A clear description
of the changes is allways welcomed.
so we can see the changes and discuss over it if necessary. A clear description
of the changes is allways welcomed.

## Good practices

Expand Down

0 comments on commit e001352

Please sign in to comment.