From b10357d664606dceaea3cd72d247543c5f9765a2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Chocholat=C3=BD?= Date: Tue, 16 Apr 2024 20:06:38 +0200 Subject: [PATCH 1/2] Define initial contributing guidelines --- CONTRIBUTING.md | 33 +++++++++++++++++++++++++++++++++ README.md | 21 +-------------------- 2 files changed, 34 insertions(+), 20 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..01945a057 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +# Contributing guidelines + +If you'd like to contribute to the libmata, please [fork the repository](https://github.com/VeriFIT/mata/fork), +create a new feature branch, and finally [create a new pull request](https://github.com/VeriFIT/mata/compare). + +In case you run into some unexpected behaviour, error or anything suspicious either contact us directly through mail or +[create a new issue](https://github.com/VeriFIT/mata/issues/new/choose). +When creating a new issue, please, try to include everything necessary for us to know (such as the version, operation +system, etc.) so we can sucessfully replicate the issue. + +## Design style + +- private attributes of classes/structs should use `snake_case_` (note the trailing `_`). +- `snake_case` is to be used in context of: + - variables, and + - functions / class methods (which are neither constructors nor destructors). +- `UpperCamelCase` is to be used in the context of: + - class/structure names, + - aliases of types created using `using`, + - constructors and destructors, and + - elements of the type `enum` (prefer using `enum class`). + +## Note to maintainers + +By default, each merge automatically increases the `minor` version of the library +(i.e., `0.0.0 -> 0.1.0` ). This can be overruled using either tag `#patch` (increasing +patch version, i.e., `0.0.0 -> 0.0.1`) or `#major` (increasing major version, i.e., +`0.0.0 -> 1.0.0`). This tag is specified in the merge message. + +Generally, it is recommended to use `#major` for changes that introduces backward-incompatible +changes for people that used previous versions, and `#patch` for minor changes, such as bug-fixes, +performance fixes or refactoring. + diff --git a/README.md b/README.md index 66e16a00e..30666ea19 100644 --- a/README.md +++ b/README.md @@ -221,26 +221,7 @@ You can either run your scripts directly using `python` or compile it using the # Contributing -If you'd like to contribute to the libmata, -please [fork the repository](https://github.com/VeriFIT/mata/fork), create a new -feature branch, and finally [create a new pull request](https://github.com/VeriFIT/mata/compare). - -In case you run into some unexpected behaviour, error or anything suspicious -either contact us directly through mail or -[create a new issue](https://github.com/VeriFIT/mata/issues/new/choose). -When creating a new issue, please, try to include everything necessary for us to know -(such as the version, operation system, etc.) so we can sucessfully replicate the issue. - -## Note to main contributors - -By default, each merge automatically increases the `minor` version of the library -(i.e., `0.0.0 -> 0.1.0` ). This can be overruled using either tag `#patch` (increasing -patch version, i.e., `0.0.0 -> 0.0.1`) or `#major` (increasing major version, i.e., -`0.0.0 -> 1.0.0`). This tag is specified in the merge message. - -Generally, it is recommended to use `#major` for changes that introduces backward-incompatible -changes for people that used previous versions, and `#patch` for minor changes, such as bug-fixes, -performance fixes or refactoring. +Please refer to our [contributing guidelines](CONTRIBUTING.md). # Links From 7e3a138969eff6165c7e79133bb84446de16588c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Chocholat=C3=BD?= Date: Fri, 26 Apr 2024 13:39:25 +0200 Subject: [PATCH 2/2] Emphasize special naming convention for private attributes --- CONTRIBUTING.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 01945a057..33e62bfa4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,12 +5,12 @@ create a new feature branch, and finally [create a new pull request](https://git In case you run into some unexpected behaviour, error or anything suspicious either contact us directly through mail or [create a new issue](https://github.com/VeriFIT/mata/issues/new/choose). -When creating a new issue, please, try to include everything necessary for us to know (such as the version, operation +When creating a new issue, please, try to include everything necessary for us to know (such as the version, operating system, etc.) so we can sucessfully replicate the issue. ## Design style -- private attributes of classes/structs should use `snake_case_` (note the trailing `_`). +- **private** attributes of classes/structs should use `snake_case_` (note the trailing `_`). - `snake_case` is to be used in context of: - variables, and - functions / class methods (which are neither constructors nor destructors). @@ -30,4 +30,3 @@ patch version, i.e., `0.0.0 -> 0.0.1`) or `#major` (increasing major version, i. Generally, it is recommended to use `#major` for changes that introduces backward-incompatible changes for people that used previous versions, and `#patch` for minor changes, such as bug-fixes, performance fixes or refactoring. -