chore(ci): add contributing instructions #2082

soonum · 2025-02-18T16:25:23Z

This change is

nsarlin-zama · 2025-02-18T16:31:15Z

CONTRIBUTING.md

+>* direct changes to CI related files are not allowed for external contributors
+>* run `make pcc` to fix any build errors before pushing commits
+
+# Data versioning


Maybe this could be ## 8 Data versioning ?

nsarlin-zama · 2025-02-18T16:31:20Z

CONTRIBUTING.md

+}
+```
+
+1. Navigate to the definition of the dispatch enum of this type. This is the type inside the `#[versionize(MyTypeVersions)]` macro attribute. In general, this type has the same name as the base type with a `Versions' suffix. You should find something like


I made a mistake with a backtick:

Suggested change

1. Navigate to the definition of the dispatch enum of this type. This is the type inside the `#[versionize(MyTypeVersions)]` macro attribute. In general, this type has the same name as the base type with a `Versions' suffix. You should find something like

1. Navigate to the definition of the dispatch enum of this type. This is the type inside the `#[versionize(MyTypeVersions)]` macro attribute. In general, this type has the same name as the base type with a `Versions` suffix. You should find something like

nsarlin-zama · 2025-02-18T16:32:06Z

CONTRIBUTING.md

+- changing the type of a field in a struct or a variant in an enum.
+
+On the contrary, these changes are *not* data breaking:
+- Renaming a type (though if it implements the `Named' trait, it can be),


Suggested change

- Renaming a type (though if it implements the `Named' trait, it can be),

- Renaming a type (though if it implements the `Named` trait, it can be),

nsarlin-zama · 2025-02-18T16:33:23Z

CONTRIBUTING.md

@@ -0,0 +1,217 @@
+# Contributing to tfhe-rs
+
+There are two ways to contribute to tfhe-rs:


I think this should be TFHE-rs ? (same for the other occurrences)

soonum

Reviewable status: 0 of 1 files reviewed, 4 unresolved discussions (waiting on @IceTDrinker and @nsarlin-zama)

soonum · 2025-02-19T09:44:47Z

CONTRIBUTING.md

@@ -0,0 +1,217 @@
+# Contributing to tfhe-rs
+
+There are two ways to contribute to tfhe-rs:


soonum · 2025-02-19T09:44:48Z

CONTRIBUTING.md

+>* direct changes to CI related files are not allowed for external contributors
+>* run `make pcc` to fix any build errors before pushing commits
+
+# Data versioning


soonum · 2025-02-19T09:44:48Z

CONTRIBUTING.md

+- changing the type of a field in a struct or a variant in an enum.
+
+On the contrary, these changes are *not* data breaking:
+- Renaming a type (though if it implements the `Named' trait, it can be),


soonum · 2025-02-19T09:44:48Z

CONTRIBUTING.md

+}
+```
+
+1. Navigate to the definition of the dispatch enum of this type. This is the type inside the `#[versionize(MyTypeVersions)]` macro attribute. In general, this type has the same name as the base type with a `Versions' suffix. You should find something like


IceTDrinker

Looks generally good

Reviewable status: 0 of 1 files reviewed, 9 unresolved discussions (waiting on @nsarlin-zama)

CONTRIBUTING.md line 3 at r2 (raw file):

# Contributing to TFHE-rs

There are two ways to contribute to TFHE-rs:

TFHE-rs branding when not in titles is (seen in the README.md format we have) same elsewhere
**TFHE-rs**

CONTRIBUTING.md line 10 at r2 (raw file):

## 1. Setting up the project

First, you need to [fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) the TFHE-rs repository and follow the installation steps described in the repository [README.md](https://github.com/zama-ai/tfhe-rs/blob/main/README.md)

we don't seem to really have installation steps ? it's the getting started section ?

Also here I would use a relative path ?

CONTRIBUTING.md line 59 at r2 (raw file):

This command ensure that all the targets in the library are building correctly.
Alternatively, you might want to run a faster version of this command using:

is that a leftover space ?

CONTRIBUTING.md line 83 at r2 (raw file):

 * locate where the code has changed
 * add (or modify) a Cargo test filter to the corresponding `make` target in Makefile
 * run the target

maybe indicate that make test_something prints the test command in the terminal and that they can copy/paste and modify it ?

CONTRIBUTING.md line 91 at r2 (raw file):

## 4. Committing

Tfhe-rs follows conventional commit specification to have a consistent commit naming scheme and you are expected to follow it as well.

wrong capitlization of TFHE-rs

CONTRIBUTING.md line 116 at r2 (raw file):

sequenceDiagram
    autonumber

leftover spaces ?

CONTRIBUTING.md line 121 at r2 (raw file):

    participant Reviewer
    participant CI-pipeline

leftover spaces ?

CONTRIBUTING.md line 123 at r2 (raw file):

    
    Contributor ->> GitHub: Open pull-request
    GitHub -->> Contributor: Ask for CLA signing (once)

letfover spaces

CONTRIBUTING.md line 130 at r2 (raw file):

        Contributor ->> GitHub: Make changes
    end
    Reviewer ->> GitHub: Pull-request approval

leftover spaces

soonum added 3 commits February 17, 2025 09:42

chore(ci): add contributing instructions

619e350

WIP: add data versionning section

341288e

WIP: add mermaid diag to explain CI process

06ab5b6

soonum requested review from IceTDrinker and nsarlin-zama February 18, 2025 16:25

soonum self-assigned this Feb 18, 2025

cla-bot bot added the cla-signed label Feb 18, 2025

nsarlin-zama reviewed Feb 18, 2025

View reviewed changes

wip: modifications after review 1

21c5c62

soonum commented Feb 19, 2025

View reviewed changes

soonum requested a review from nsarlin-zama February 19, 2025 09:45

IceTDrinker reviewed Feb 19, 2025

View reviewed changes

soonum requested a review from IceTDrinker February 20, 2025 07:53

soonum force-pushed the dt/chore/contributing branch 2 times, most recently from 6f9a6c2 to 2b1db6f Compare February 20, 2025 08:02

wip: modifications after review 2

96afc32

soonum force-pushed the dt/chore/contributing branch from 2b1db6f to 96afc32 Compare February 20, 2025 08:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(ci): add contributing instructions #2082

chore(ci): add contributing instructions #2082

soonum commented Feb 18, 2025 •

edited

Loading

nsarlin-zama Feb 18, 2025

soonum Feb 19, 2025

nsarlin-zama Feb 18, 2025

soonum Feb 19, 2025

nsarlin-zama Feb 18, 2025

soonum Feb 19, 2025

nsarlin-zama Feb 18, 2025

soonum Feb 19, 2025

soonum left a comment

soonum Feb 19, 2025

soonum Feb 19, 2025

soonum Feb 19, 2025

soonum Feb 19, 2025

IceTDrinker left a comment

	1. Navigate to the definition of the dispatch enum of this type. This is the type inside the `#[versionize(MyTypeVersions)]` macro attribute. In general, this type has the same name as the base type with a `Versions' suffix. You should find something like
	1. Navigate to the definition of the dispatch enum of this type. This is the type inside the `#[versionize(MyTypeVersions)]` macro attribute. In general, this type has the same name as the base type with a `Versions` suffix. You should find something like

	- Renaming a type (though if it implements the `Named' trait, it can be),
	- Renaming a type (though if it implements the `Named` trait, it can be),

		@@ -0,0 +1,217 @@
		# Contributing to tfhe-rs

		There are two ways to contribute to tfhe-rs:

chore(ci): add contributing instructions #2082

Are you sure you want to change the base?

chore(ci): add contributing instructions #2082

Conversation

soonum commented Feb 18, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

soonum left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

IceTDrinker left a comment

Choose a reason for hiding this comment

soonum commented Feb 18, 2025 •

edited

Loading