Compare revisions

[alias]

cucumber = "test -p duniter-end2end-tests --test cucumber_tests --"

sanity-gdev = "test -p duniter-live-tests --test sanity_gdev -- --nocapture"

tu = "test --workspace --exclude duniter-end2end-tests --exclude duniter-live-tests"

tb = "test --features runtime-benchmarks -p"

rbp = "run --release --features runtime-benchmarks -- benchmark pallet --chain=dev --steps=50 --repeat=20 --extrinsic=* --execution=wasm --wasm-execution=compiled --heap-pages=4096 --header=./file_header.txt --output=. --pallet"

xtask = "run --package xtask --"

[alias]

sanity-gdev = "test -Zgit=shallow-deps -p duniter-live-tests --test sanity_gdev -- --nocapture"

tu = "test -Zgit=shallow-deps --workspace --exclude duniter-end2end-tests --exclude duniter-live-tests --features constant-fees" # Unit tests with constant-fees

tf = "test -Zgit=shallow-deps --workspace --exclude duniter-end2end-tests --exclude duniter-live-tests test_fee" # Custom fee model tests

# `te` and `cucumber` are synonyms

te = "test -p duniter-end2end-tests --test cucumber_tests --features constant-fees --"

cucumber-build = "build -Zgit=shallow-deps --features constant-fees"

cucumber = "test -Zgit=shallow-deps -p duniter-end2end-tests --test cucumber_tests --"

ta = "test -Zgit=shallow-deps --workspace --exclude duniter-live-tests --features constant-fees"

tb = "test -Zgit=shallow-deps --features runtime-benchmarks -p"

rbp = "run -Zgit=shallow-deps --release --features runtime-benchmarks -- benchmark pallet --chain=dev --steps=50 --repeat=20 --extrinsic=* --execution=wasm --wasm-execution=compiled --heap-pages=4096 --header=./file_header.txt --output=. --pallet"

xtask = "run -Zgit=shallow-deps --package xtask --"

cucumber-node = "run -Zgit=shallow-deps -- --chain=gdev_dev --execution=Native --sealing=manual --force-authoring --rpc-cors=all --tmp --rpc-port 9944 --alice --features constant-fees"

docker-compose.yml

docker-compose.yml

arm-build/

arm-build/

**/target/

**/target/

build/

# check if executable works in this container

# check if executable works in this container

RUN /usr/local/bin/duniter --version

RUN /usr/local/bin/duniter --version

EXPOSE 30333 9933 9944

EXPOSE 30333 9944

VOLUME ["/duniter"]

VOLUME ["/duniter"]

ENTRYPOINT ["/usr/local/bin/duniter"]

ENTRYPOINT ["/usr/local/bin/duniter"]

    100

    100

  ],

  ],

  "[json]": {

  "[json]": {

    "editor.defaultFormatter": "esbenp.prettier-vscode"

    "editor.defaultFormatter": "vscode.json-language-features"

  },

  },

  "[yaml]": {

  "[yaml]": {

    "editor.defaultFormatter": "esbenp.prettier-vscode"

    "editor.defaultFormatter": "esbenp.prettier-vscode"

    "port_p2p": 19931,

    "port_p2p": 19931,

    "port_rpc": 19932,

    "port_rpc": 19932,

    "port_ws": 19933

    "port_ws": 19933

  }

  },

  "rust-analyzer.showUnlinkedFileNotification": false

}

}

 No newline at end of file

[Setting up your development environment]

[Setting up your development environment]

Sign-ups on our gitlab are disabled. If you would like to contribute, please ask for its creation on [the technical forum].

Sign-ups on our gitlab are disabled. If you would like to contribute, please ask for an account on [the technical forum].

When contributing to this repository, please first discuss the change you wish to make via issue or

When contributing to this repository, please first discuss the change you wish to make via issue or

via [the technical forum] before making a change.

via [the technical forum] before making a change.

## Developer documentation

## Developer documentation

Please read [Developer documentation] before contribute.

Please read [Developer documentation] before contributing.

## Workflow

## Workflow

- If there is an unassigned issue about the thing you want to contribute to, assign the issue to yourself.

- Create a branch based on `master` and prefixed with your nickname. Give your branch a short name indicating the subject.

- Create a branch based on `master` and prefixed with your nickname. Give your branch a short name indicating the subject.

- Create an MR from your branch to `master`.

- Create an MR from your branch to `master`. Prefix the title with `Draft: ` until it's ready to be merged.

- Never contribute to a branch of another contributor! If the contributor makes a `git rebase` your commit will be lost!

- If the MR is related to an issue, mention the issue in the description using the `#42` syntax.

- Never push to a branch of another contributor! If the contributor makes a `git rebase` your commit will be lost!

- Before you push your commit:

- Before you push your commit:

  - Apply formatters (rustfmt and prettier) and linter (clippy)

  - Apply formatters (rustfmt and prettier) and linter (clippy)

  - Document your code

  - Document your code

1. Ensure you rebased your branch on the latest `master` commit to avoid any merge conflicts.

1. Ensure you rebased your branch on the latest `master` commit to avoid any merge conflicts.

1. Ensure that you respect the [commit naming conventions].

1. Ensure that you respect the [commit naming conventions].

1. Ensure that all automated tests pass with the `cargo test` command.

1. Ensure that all automated tests pass with the `cargo test` command.

1. Ensure that the code is well formated `cargo fmt` and comply with the good practices `cargo clippy`. If you have been working on tests, check everything with `cargo clippy --all --tests`.

1. Ensure that the code is well formatted `cargo fmt` and complies with the good practices `cargo clippy`. If you have been working on tests, check everything with `cargo clippy --all --tests`.

1. Update the documentation with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.

1. Update the documentation with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.

1. Push your branch on the gitlab and create a merge request. Briefly explain the purpose of your contribution in the description of the merge request.

1. Push your branch on the gitlab and create a merge request. Briefly explain the purpose of your contribution in the description of the merge request.

1. Tag a Duniter reviewer so they will review your contribution. If you still have no news after several weeks, tag another reviewer or/and talk about your contribution on [the technical forum].

1. Mark the MR as ready (or remove the `Draft: ` prefix) only when you think it can be reviewed or merged.

1. Assign a Duniter reviewer so they will review your contribution. If you still have no news after several weeks, ask explicitly for a review, or tag another reviewer or/and talk about your contribution on [the technical forum].

## List of Duniter's reviewers

## List of Duniter's reviewers

- @librelois

- @HugoTrentesaux

- @tuxmain

- @tuxmain

[commit naming conventions]: ./docs/dev/git-conventions.md#naming-commits

[commit naming conventions]: ./docs/dev/git-conventions.md#naming-commits