From 1cde06cb5d61aa2704e1b2e0d8bc01fb59359e3b Mon Sep 17 00:00:00 2001 From: "Documenter.jl" Date: Tue, 31 Oct 2023 21:15:23 +0000 Subject: [PATCH] build based on d27aaa9 --- dev/.documenter-siteinfo.json | 2 +- dev/contributing/index.html | 2 +- dev/developer/index.html | 2 +- dev/index.html | 2 +- dev/reference/index.html | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index bcc863e1..d1142507 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-31T19:41:02","documenter_version":"1.1.2"}} \ No newline at end of file +{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-31T21:15:18","documenter_version":"1.1.2"}} \ No newline at end of file diff --git a/dev/contributing/index.html b/dev/contributing/index.html index 123c48eb..b18a0119 100644 --- a/dev/contributing/index.html +++ b/dev/contributing/index.html @@ -1,2 +1,2 @@ -Contributing · COPIERTemplate.jl

Contributing guidelines

First of all, thanks for the interest!

We welcome all kinds of contribution, including, but not limited to code, documentation, examples, configuration, issue creating, etc.

Be polite and respectful.

Bug reports and discussions

If you think you found a bug, feel free to open an issue. Focused suggestions and requests can also be opened as issues. Before opening a pull request, start an issue or a discussion on the topic, please.

Working on an issue

If you found an issue that interests you, comment on that issue what your plans are. 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

Feel free to ping us after a few days if there are no responses.

If your solution involves code (or something that requires running the package locally), check the developer documentation. Otherwise, you can use the GitHub interface directly to create your pull request.

+Contributing · COPIERTemplate.jl

Contributing guidelines

First of all, thanks for the interest!

We welcome all kinds of contribution, including, but not limited to code, documentation, examples, configuration, issue creating, etc.

Be polite and respectful.

Bug reports and discussions

If you think you found a bug, feel free to open an issue. Focused suggestions and requests can also be opened as issues. Before opening a pull request, start an issue or a discussion on the topic, please.

Working on an issue

If you found an issue that interests you, comment on that issue what your plans are. 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

Feel free to ping us after a few days if there are no responses.

If your solution involves code (or something that requires running the package locally), check the developer documentation. Otherwise, you can use the GitHub interface directly to create your pull request.

diff --git a/dev/developer/index.html b/dev/developer/index.html index 838f172e..6964a407 100644 --- a/dev/developer/index.html +++ b/dev/developer/index.html @@ -2,4 +2,4 @@ Dev setup · COPIERTemplate.jl

Developer documentation

If you haven't, please read the Contributing guidelines first.

Linting and formatting

Install a plugin on your editor to use EditorConfig. This will ensure that your editor is configured with important formatting settings.

We use https://pre-commit.com to run the linters and formatters. In particular, the Julia code is formatted using JuliaFormatter.jl, so please install it globally first.

To install pre-commit, we recommend using pipx as follows:

# Install pipx following the link
 pipx install pre-commit

With pre-commit installed, activate it as a pre-commit hook:

pre-commit install

To run the linting and formatting manually, enter the command below:

pre-commit run -a

Now, you can only commit if all the pre-commit tests pass.

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/abelsiqueira/COPIERTemplate.jl

Working on a new issue

  1. Fetch from the JSO remote and fast-forward your local main

    git fetch orgremote
 git switch main
-git merge --ff-only orgremote/main

  2. Branch from main to address the issue (see below for naming)

    git switch -c 42-add-answer-universe

  3. Push the new local branch to your personal remote repository

    git push -u origin 42-add-answer-universe

  4. Create a pull request to merge your remote branch into the org main.

Branch naming

  • If there is an associated issue, add the issue number.
  • If there is no associated issue, and the changes are small, add a prefix such as "typo", "hotfix", "small-refactor", according to the type of update.
  • If the changes are not small and there is no associated issue, then create the issue first, so we can properly discuss the changes.
  • Use dash separated imperative wording related to the issue (e.g., 14-add-tests, 15-fix-model, 16-remove-obsolete-files).

Commit message

  • 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

  • [Advanced] Try to create "atomic git commits" (recommended reading: The Utopic Git History).

  • Make sure the tests pass.

  • Make sure the pre-commit tests pass.

  • Fetch any main updates from upstream and rebase your branch, if necessary:

    bash git fetch orgremote git rebase orgremote/main BRANCH_NAME

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

+git merge --ff-only orgremote/main

  • Branch from main to address the issue (see below for naming)

    git switch -c 42-add-answer-universe

  • Push the new local branch to your personal remote repository

    git push -u origin 42-add-answer-universe

  • Create a pull request to merge your remote branch into the org main.

    • Branch naming

    Commit message

    Before creating a pull request

    diff --git a/dev/index.html b/dev/index.html index d3ec7420..6a0617d8 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,2 +1,2 @@ -Home · COPIERTemplate.jl
    +Home · COPIERTemplate.jl
    diff --git a/dev/reference/index.html b/dev/reference/index.html index e7673ec9..d618d66f 100644 --- a/dev/reference/index.html +++ b/dev/reference/index.html @@ -1,2 +1,2 @@ -Reference · COPIERTemplate.jl

    Reference

    Contents

    Index

    COPIERTemplate.generate — Function
    generate(path, generate_missing_uuid = true; kwargs...)

    Runs the copy command of copier with the COPIERTemplate template. Even though the template is available offline through this template, this uses the github URL to allow updating.

    The keyword arguments are passed directly to the run_copy function of copier. If generate_missing_uuid is true and there is no kwargs[:data]["PackageUUID"], then a UUID is generated for the package.

    source
    +Reference · COPIERTemplate.jl

    Reference

    Contents

    Index

    COPIERTemplate.generate — Function
    generate(path, generate_missing_uuid = true; kwargs...)

    Runs the copy command of copier with the COPIERTemplate template. Even though the template is available offline through this template, this uses the github URL to allow updating.

    The keyword arguments are passed directly to the run_copy function of copier. If generate_missing_uuid is true and there is no kwargs[:data]["PackageUUID"], then a UUID is generated for the package.

    source