Skip to content

Commit

Permalink
Add a bit more information to applying to existing projects
Browse files Browse the repository at this point in the history
  • Loading branch information
abelsiqueira committed Jun 8, 2024
1 parent 1a2fefa commit 6e17f32
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/src/10-full-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,10 @@ julia> COPIERTemplate.generate("full/path/to/YourPackage.jl")
This will look for a file `Project.toml` at the root of the given path and use the information there to guess some of the answers.
Currently, we guess the `PackageName`, `PackageUUID` from the `name` and `uuid` fields, and try to guess the `AuthorName` and `AuthorEmail` from the `authors` field by looking at the first match.

If you don't like the result, or want to override the answers, you can run the `generate` function with a additional arguments:
!!! tip "Overwrite"
You will be asked whether to overwrite existing files or not. Since you are using `git`, you can try it out and reset if you don't like the result.

If you don't like the result, or want to override the answers, you can run the `generate` function with additional arguments:

```julia-repl
julia> data = Dict("AuthorName" => "Bob", "AuthorEmail" => "[email protected]")
Expand All @@ -117,10 +120,11 @@ Unfortunately, they are not shown to you when the conflict appears, so the best
After the template is applied and you are happy with the conflict resolution, enable pre-commit and push your code.

```bash
git add .
pre-commit run -a # Try to fix possible pre-commit issues (failures are expected)
pre-commit install # All commits will run pre-commit now
git add .
git commit -m "Apply COPIERTemplate vx.y.z"
pre-commit install # Future commits can't be directly to main unless you use -n
```

Push your code to GitHub and head to [Setting up your package](@ref) for information on what to do next.
Expand Down

0 comments on commit 6e17f32

Please sign in to comment.