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
4 changes: 3 additions & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ body:
- type: markdown
attributes:
value: |
Follow the [contributing guidelines](../../development/contributing.md).
Follow the [contributing guidelines](https://github.com/Simple-Robotics/nanoeigenpy/blob/main/CONTRIBUTING.md).

If you have a question about how to use nanoeigenpy, open a [discussion](https://github.com/Simple-Robotics/nanoeigenpy/discussions).

Expand Down Expand Up @@ -59,6 +59,8 @@ body:
attributes:
label: Checklist
options:
- label: I have read the [contributing guidelines](https://github.com/Simple-Robotics/nanoeigenpy/blob/main/CONTRIBUTING.md)
required: true
- label: I have checked that all my packages are installed from the same package manager (conda-forge, Nix, PyPI, robotpkg, ROS, ...)
required: true
- label: I have checked that there is no similar [issue](https://github.com/Simple-Robotics/nanoeigenpy/issues)/[discussion](https://github.com/Simple-Robotics/nanoeigenpy/discussions)
Expand Down
4 changes: 3 additions & 1 deletion .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ body:
- type: markdown
attributes:
value: |
Follow the [contributing guidelines](../../development/contributing.md).
Follow the [contributing guidelines](https://github.com/Simple-Robotics/nanoeigenpy/blob/main/CONTRIBUTING.md).

If you have a question about how to use nanoeigenpy, open a [discussion](https://github.com/Simple-Robotics/nanoeigenpy/discussions).

Expand Down Expand Up @@ -43,6 +43,8 @@ body:
attributes:
label: Checklist
options:
- label: I have read the [contributing guidelines](https://github.com/Simple-Robotics/nanoeigenpy/blob/main/CONTRIBUTING.md)
required: true
- label: I have checked that there is no similar [issue](https://github.com/Simple-Robotics/nanoeigenpy/issues)/[discussion](https://github.com/Simple-Robotics/nanoeigenpy/discussions)
in the repo
required: true
Expand Down
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
Follow the [contributing guidelines](../development/contributing.md).
Follow the [contributing guidelines](https://github.com/Simple-Robotics/nanoeigenpy/blob/main/CONTRIBUTING.md).
-->

## Description
Expand All @@ -13,7 +13,7 @@ If the pull request fixes an issue, link it with "Fixes #issue_number".

## Checklist

- [ ] I have read the [contributing guidelines](../development/contributing.md)
- [ ] I have read the [contributing guidelines](https://github.com/Simple-Robotics/nanoeigenpy/blob/main/CONTRIBUTING.md)
- [ ] I have run `pre-commit run --all-files` or `pixi run lint`
- [ ] I have reviewed my own code
- [ ] I have commented my code where necessary
Expand Down
10 changes: 5 additions & 5 deletions development/contributing.md → CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Whether it's a bug report, a new feature, a fix, or documentation, we value ever

Read this document before opening an issue or a pull request.

All communication on this project must follow the [Code of Conduct](../CODE_OF_CONDUCT.md).
All communication on this project must follow the [Code of Conduct](CODE_OF_CONDUCT.md).

## Table of contents

Expand Down Expand Up @@ -62,7 +62,7 @@ If an issue meets these criteria, claim it with a short comment.

### Set up the development environment

The easiest way to set up a development environment is to use pixi, as described in the [build documentation](build.md).
The easiest way to set up a development environment is to use pixi, as described in the [build documentation](development/build.md).

See the CI workflows for examples with other package managers.

Expand All @@ -79,7 +79,7 @@ In your pull request:
- Keep it to a single self-contained change. Don't mix unrelated fixes.
- Keep backward compatibility. Don't break the API.
- Write tests that cover your changes.
- Add an entry to the [changelog](../CHANGELOG.md).
- Add an entry to the [changelog](CHANGELOG.md).
- Make sure code style checks pass (`pixi run lint` or `pre-commit run --all-files`).
- Make sure the CI is green. Ask for help if you're stuck on a CI issue.
- Check all the appropriate items in the pull request template checklist.
Expand Down Expand Up @@ -112,7 +112,7 @@ ctest --test-dir build --output-on-failure -R <test-name>

### Code style

Code style is enforced with [pre-commit](https://pre-commit.com/) hooks configured in [.pre-commit-config.yaml](../.pre-commit-config.yaml).
Code style is enforced with [pre-commit](https://pre-commit.com/) hooks configured in [.pre-commit-config.yaml](.pre-commit-config.yaml).
Before pushing your changes, run:

```bash
Expand Down Expand Up @@ -181,4 +181,4 @@ It breaks the responsibility and communication rules.

## Licensing

All contributions to this repository are under the BSD 2-Clause License, as stated in [LICENSE](../LICENSE).
All contributions to this repository are under the BSD 2-Clause License, as stated in [LICENSE](LICENSE).
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ cmake --build . --target install

## Contribution

If you want to ask a question, report a bug, request a new feature or contributing with a pull requests please, follow the [contribution guideline](./development/contributing.md).
If you want to ask a question, report a bug, request a new feature or contributing with a pull requests please, follow the [contribution guideline](./CONTRIBUTING.md).


## Core-dev team
Expand Down
22 changes: 3 additions & 19 deletions development/scripts/pixi/activation.sh
Original file line number Diff line number Diff line change
@@ -1,31 +1,15 @@
#! /bin/bash
# Activation script

# Remove flags setup from cxx-compiler
unset CFLAGS
unset CPPFLAGS
unset CXXFLAGS
unset DEBUG_CFLAGS
unset DEBUG_CPPFLAGS
unset DEBUG_CXXFLAGS
unset LDFLAGS

if [[ $host_alias == *"apple"* ]];
then
# On OSX setting the rpath and -L it's important to use the conda libc++ instead of the system one.
# If conda-forge use install_name_tool to package some libs, -headerpad_max_install_names is then mandatory
export LDFLAGS="-Wl,-headerpad_max_install_names -Wl,-rpath,$CONDA_PREFIX/lib -L$CONDA_PREFIX/lib"
elif [[ $host_alias == *"linux"* ]];
if [[ $PIXI_ENVIRONMENT_PLATFORMS == *"linux"* ]];
then
# On GNU/Linux, I don't know if these flags are mandatory with g++ but
# it allow to use clang++ as compiler
export LDFLAGS="-Wl,-rpath,$CONDA_PREFIX/lib -Wl,-rpath-link,$CONDA_PREFIX/lib -L$CONDA_PREFIX/lib"
# Conda compiler is named x86_64-conda-linux-gnu-c++, ccache can't resolve it
# (https://ccache.dev/manual/latest.html#config_compiler_type)
export CCACHE_COMPILERTYPE=gcc
fi

# Without -isystem, some LSP can't find headers
export NANOEIGENPY_CXX_FLAGS="$CXXFLAGS $NANOEIGENPY_CXX_FLAGS -isystem $CONDA_PREFIX/include"
export NANOEIGENPY_CXX_FLAGS="$NANOEIGENPY_CXX_FLAGS -isystem $CONDA_PREFIX/include"

# Set default build value only if not previously set
export NANOEIGENPY_BUILD_TYPE=${NANOEIGENPY_BUILD_TYPE:=Release}
Expand Down
Loading