Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 15 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ The following is a set of guidelines to [`Manifolds.jl`](https://juliamanifolds.
* [Provide a new manifold](#provide-a-new-manifold)
* [Code style](#Code-style)
* [Spell checking](#Spell-checking)
* [On the use of AI](#On-the-use-of-AI)

## How to ask a question

Expand Down Expand Up @@ -91,7 +92,7 @@ Please follow the [documentation guidelines](https://docs.julialang.org/en/v1/ma
Please consider a few internal conventions:


* Please include a description of the manifold and a reference to the general theory in the `struct` of your manifold that inherits from `AbstractManifold`'.
* Please include a description of the manifold and a reference to the general theory in the `struct` of your manifold that inherits from `AbstractManifold`.
* Include the mathematical formulae for any implemented function if a closed form exists.
* Within the source code of one manifold, the `struct` the manifold should be the first element of the file.
* an alphabetical order of functions in every file is preferable.
Expand All @@ -106,4 +107,16 @@ Please consider a few internal conventions:

## Spell checking

We use [crate-ci/typos](https://github.com/crate-ci/typos) for spell checking, which is run automatically on GitHub Actions, but you can also run it locally using their command line tool.
We use [crate-ci/typos](https://github.com/crate-ci/typos) for spell checking, which is run automatically on GitHub Actions, but you can also run it locally using their command line tool.

## On the use of AI

Following the [Julia Discourse Guidelines – Keep it tidy](https://discourse.julialang.org/faq#keep-tidy),
please do not open PRs or issues that are pure AI generated. `Manifolds.jl` is in its aspects,
especially the code, the documentation, as well as the tests, carefully curated to be concise,
well-documented, comprehensive, but in tests also in a (hopefully) good balance between
ensuring functionality and “over testing”.

Of course it is ok to get help from an AI, e.g. when refactoring parts of the code,
but please always carefully reflect on the results proposed and do not “[vibe code](https://en.wikipedia.org/wiki/Vibe_coding)”. That usually does not work well nor fit the exact mathematical definitions,
reliability and stability as well as and abstractions `Manifolds.jl` aims to provide.
6 changes: 6 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ All notable changes to ´Manifolds.jl´ will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.11.22] unreleased

### Added

* A clarification on the use of AI in the [CONTRIBUTING.md](https://juliamanifolds.github.io/Manifolds.jl/stable/misc/CONTRIBUTING/) (#886)

## [0.11.21] 2025-04-03

### Changed
Expand Down
Loading