Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
133 lines (84 loc) · 3.34 KB

CONTRIBUTING.md

File metadata and controls

133 lines (84 loc) · 3.34 KB

Contributing

🚀 Thank you for contributing to cdevents! 🚀

Architecture

The workspace is composed of:

  • cdevents-sdk: the published rust crate
  • cdevents-specs: the different version of cdevent's specifications used to generate and validate part of cdevents-sdk
  • generator: the code generator, used to generate a part of cdevents-sdk from cdevents-specs

Few design's rules:

  • The generated code is commited, so users of cdevents-sdk don't to generate it at each build.
  • TO COMPLETE

Setting up a development environment

Setup a GitHub account accessible via SSH

GitHub is used for project Source Code Management (SCM) using the SSH protocol for authentication.

  1. Create a GitHub account if you do not already have one.
  2. Setup GitHub access via SSH

Install tools

You must install these tools:

  1. git: For source control

  2. mise:

  • mise install: to install complementary tools, sdk,...
  • mise tasks: to list all tasks used to build

Setup a fork

The sdk-rust project requires that you develop (commit) code changes to branches that belong to a fork of the cdevents/sdk-rust repository in your GitHub account before submitting them as Pull Requests (PRs) to the actual project repository.

  1. Create a fork of the cdevents/sdk-rust repository in your GitHub account.

  2. Create a clone of your fork on your local machine:

    git clone [email protected]:${YOUR_GITHUB_USERNAME}/sdk-rust.git

  3. Configure git remote repositories

    Adding cdevents/sdk-rust as the upstream and your fork as the origin remote repositories to your .git/config sets you up nicely for regularly syncing your fork and submitting pull requests.

    1. Change into the project directory

      cd sdk-rust

    2. Retrieve submodules

      git submodule init
git submodule update --init --recursive

    3. Configure sdk-rust as the upstream repository

      git remote add upstream [email protected]:cdevents/sdk-rust.git

# Optional: Prevent accidental pushing of commits by changing the upstream URL to `no_push`
git remote set-url --push upstream no_push

    4. Configure your fork as the origin repository

      git remote add origin [email protected]:${YOUR_GITHUB_USERNAME}/sdk-rust.git

Development

Work into a branch

git switch -c feat_foo

Building and testing

To format the rust code and imports:

mise run fmt

To run the all the tasks like the ci:

mise run ci

To run unit tests:

mise run test

Commit & push

Commit's message should follow the conventional commit convention: e.g.

feat: my super feature

...
fix: bug blablabla

FIX #99

Review & merge

Create a PR (pull request) and ask for review. The last reviewer, will "Squash & merge" when ready. The message of the squashed commit follows the conventional commit, and aggregate/summaries commits of the branch.