diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index df4ac76..91012f6 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-20T11:15:09","documenter_version":"1.8.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.11.3","generation_timestamp":"2025-03-05T12:42:55","documenter_version":"1.8.1"}} \ No newline at end of file diff --git a/dev/90-contributing/index.html b/dev/90-contributing/index.html index dbd76e0..8b86a44 100644 --- a/dev/90-contributing/index.html +++ b/dev/90-contributing/index.html @@ -1,2 +1,2 @@ -Contributing guidelines · ConvolutionalNeuralOperators.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, and follow the code of conduct.

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 guidelines · ConvolutionalNeuralOperators.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, and follow the code of conduct.

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/91-developer/index.html b/dev/91-developer/index.html index 4a3c774..9a5d1bf 100644 --- a/dev/91-developer/index.html +++ b/dev/91-developer/index.html @@ -7,4 +7,4 @@ pkg> test

Working on a new issue

We try to keep a linear history in this repo, so it is important to keep your branches up-to-date.

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

    git fetch upstream
 git switch main
 git merge --ff-only upstream/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

Commit message

Before creating a pull request

Atomic git commits

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

Building and viewing the documentation locally

Following the latest suggestions, we recommend using LiveServer to build the documentation. Here is how you do it:

  1. Run julia --project=docs to open Julia in the environment of the docs.
  2. If this is the first time building the docs
    1. Press ] to enter pkg mode
    2. Run pkg> dev . to use the development version of your package
    3. Press backspace to leave pkg mode
  3. Run julia> using LiveServer
  4. Run julia> servedocs()

Making a new release

To create a new release, you can follow these simple steps:

After that, you only need to wait and verify:

+git rebase upstream/main BRANCH_NAME

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

    • Building and viewing the documentation locally

    Following the latest suggestions, we recommend using LiveServer to build the documentation. Here is how you do it:

    1. Run julia --project=docs to open Julia in the environment of the docs.
    2. If this is the first time building the docs
      1. Press ] to enter pkg mode
      2. Run pkg> dev . to use the development version of your package
      3. Press backspace to leave pkg mode
    3. Run julia> using LiveServer
    4. Run julia> servedocs()

    Making a new release

    To create a new release, you can follow these simple steps:

    After that, you only need to wait and verify:

    diff --git a/dev/95-reference/index.html b/dev/95-reference/index.html index 4429f23..bf016a9 100644 --- a/dev/95-reference/index.html +++ b/dev/95-reference/index.html @@ -1,2 +1,2 @@ -Reference · ConvolutionalNeuralOperators.jl
    +Reference · ConvolutionalNeuralOperators.jl
    diff --git a/dev/index.html b/dev/index.html index 00c76b0..947586e 100644 --- a/dev/index.html +++ b/dev/index.html @@ -13,4 +13,4 @@ - +