From 000e3af0692552304034751029aad0639df5546b Mon Sep 17 00:00:00 2001 From: Antonis Kotsis Date: Tue, 20 Jun 2023 15:30:42 +0200 Subject: [PATCH 1/3] Added coding guidelines to README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6f2f2a7..c729c36 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ Bloom filter library ================================ -[Changelog](CHANGELOG.md) | [Setup](#install) | [Docs](#usage) | [Maven Repo](https://bintray.com/baqend/maven/Orestes-Bloomfilter) +[Changelog](CHANGELOG.md) | [Setup](#install) | [Docs](#usage) | [Maven Repo](https://bintray.com/baqend/maven/Orestes-Bloomfilter) | [Contributing](https://www.notion.so/Coding-Guidelines-161d619cb9d54299bb7717b848140a53) Version 1 is out with a complete rewrite of almost all functionalities and many new ones. From c8575347594c1a1e854a376dcbbccc4c6afc4c4a Mon Sep 17 00:00:00 2001 From: Antonis Kotsis Date: Thu, 22 Jun 2023 16:37:45 +0200 Subject: [PATCH 2/3] refactor: updated READEME and added CONTRIBUTING file --- CONTRIBUTING.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 13 ++++++++++- 2 files changed, 73 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f56f65a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,61 @@ +Contributing +============ + +We are working on a feature branch basis. That means, if you want to impelement a new feature, refactor something, or +add any other change, you branch you feature branch of the master branch. That is the branch on which you will do you work. +The following sections will tell you how you should you feature branches, how to keep your feature branch up to date and +how to write good commit messages. + +Feature branch mames +-------------------- + +Branches should fulfill the following name scheme: + + ///[]_ + +For example: + + 2023/44/feat/BAQ-1111_disable_speed_kit_on_many_errors + 2023/27/fix/BBQ-123_implement_feature_xyz + +Keeping your feature branch up to date +-------------------------------------- + +Make sure to regularily __rebase__ your feature branch onto the master branch to prevent diverging too much from it. +You might miss changes which could touch the files you're working on which will result in a lot of merge conflicts. + +The simplest way to do that is by using IntelliJ: +* Check out your feature branch +* Updat the master branch +* Rebase your branch onto the master branch by selecting the master branch and choosing `Rebase current onto selected` + +Take a look [here](https://www.jetbrains.com/help/idea/apply-changes-from-one-branch-to-another.html#rebase-branch) for more details on how to properly rebase with IntelliJ. + +Commit message format and content +--------------------------------- + +Commits should have the following scheme: + + (): + +With the following values for ``: + +- **feat:** new feature +- **fix:** bug fix +- **refactor:** refactoring production code +- **style:** formatting, missing semi colons, etc; no code change +- **docs:** changes to documentation +- **test:** adding or refactoring tests; no production code change +- **chore:** updating grunt tasks etc; no production code change + +The `` is optional but we encourage to use them for better +separation of commits within a branch. Example values could be: assets, server, build, general + +For example: + + feat(server): Implement changeOrigin on AssetAPI + +The commit message should contain a short explanaition what the commited change is doing. There is no need in repeating t +the change itself since it's self explainatory by the code change. + +Please refer to [this article](https://chris.beams.io/posts/git-commit/#imperative) to to see how to write good commit messages. diff --git a/README.md b/README.md index c729c36..f1495c3 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,18 @@ Bloom filter library ================================ -[Changelog](CHANGELOG.md) | [Setup](#install) | [Docs](#usage) | [Maven Repo](https://bintray.com/baqend/maven/Orestes-Bloomfilter) | [Contributing](https://www.notion.so/Coding-Guidelines-161d619cb9d54299bb7717b848140a53) +[Changelog](CHANGELOG.md) | [Setup](#install) | [Docs](#usage) | [Maven Repo](https://bintray.com/baqend/maven/Orestes-Bloomfilter) + +__Please review the [contribution guide](CONTRIBUTING.md) and the [coding guidelines](https://www.notion.so/Coding-Guidelines-161d619cb9d54299bb7717b848140a53) for information on how to contribute to this project before supplying a merge request.__ + +## Getting Started + +### Rules + +* New fixes, features or other code work is done in separate branches. Please refer to the [contribution guide](CONTRIBUTING.md) for branch naming rules and + other rules on contributing to this project. +* Regularily (at leas once a day) ***rebase*** your feature branch onto the master branch. This will make sure, that you're working on the most up-to-date code. + The chance for merge conflicts is much lower as well. Version 1 is out with a complete rewrite of almost all functionalities and many new ones. From 6ab2124fb0717196d289eb569e7412b9dfd16231 Mon Sep 17 00:00:00 2001 From: Antonis Kotsis Date: Fri, 23 Jun 2023 11:48:31 +0200 Subject: [PATCH 3/3] refactor:removed links --- CONTRIBUTING.md | 6 +++--- README.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f56f65a..a2cf7cc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,12 +11,12 @@ Feature branch mames Branches should fulfill the following name scheme: - ///[]_ + /// For example: - 2023/44/feat/BAQ-1111_disable_speed_kit_on_many_errors - 2023/27/fix/BBQ-123_implement_feature_xyz + 2023/44/feat/disable_speed_kit_on_many_errors + 2023/27/fix/implement_feature_xyz Keeping your feature branch up to date -------------------------------------- diff --git a/README.md b/README.md index f1495c3..813ac87 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Bloom filter library [Changelog](CHANGELOG.md) | [Setup](#install) | [Docs](#usage) | [Maven Repo](https://bintray.com/baqend/maven/Orestes-Bloomfilter) -__Please review the [contribution guide](CONTRIBUTING.md) and the [coding guidelines](https://www.notion.so/Coding-Guidelines-161d619cb9d54299bb7717b848140a53) for information on how to contribute to this project before supplying a merge request.__ +__Please review the [contribution guide](CONTRIBUTING.md) for information on how to contribute to this project before supplying a merge request.__ ## Getting Started