docs: add contributing.md and refer it to readme.md

tabkram · Nov 22, 2023 · e4cc686 · e4cc686 · github-actions · Nov 22, 2023
1 parent 6a39d9d
commit e4cc686
Show file tree

Hide file tree

Showing 2 changed files with 81 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,76 @@
+# Contributing to Execution Engine 🚀
+
+Thank you for considering contributing to Execution Engine! We appreciate your interest and support in making this project even better.
+
+As a contributor, here are the guidelines we would like you to follow:
+
+- [Coding Rules](#rules)
+- [Commit Message Guidelines](#commit)
+
+## <a name="rules"></a> Coding Rules
+To ensure consistency throughout the source code, keep these rules in mind as you are working:
+
+* All features or bug fixes **must be tested** by one or more specs (unit-tests).
+* All public API methods **must be documented**.
+
+## <a name="commit"></a> Commit Message Format
+
+*This specification is inspired by and supersedes the [AngularJS commit message format][commit-message-format].*
+
+We have very precise rules over how our Git commit messages must be formatted.
+This format leads to **easier to read commit history**.
+
+Each commit message consists of a **header**, a **body**, and a **footer**.
+
+
+```
+<header>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+The `header` is mandatory and must conform to the [Commit Message Header](#commit-header) format.
+
+The `body` is mandatory for all commits except for those of type "docs".
+When the body is present it must be at least 20 characters long and must conform to the [Commit Message Body](#commit-body) format.
+
+The `footer` is optional. The [Commit Message Footer](#commit-footer) format describes what the footer is used for and the structure it must have.
+
+
+#### <a name="commit-header"></a>Commit Message Header
+
+```
+<type>(<scope>):  <short summary>
+  │       │             │
+  │       │             └─⫸ Summary in present tense. Not capitalized. No period at the end.
+  │       │
+  │       └─⫸ Commit Scope: animations|bazel|benchpress|common|compiler|compiler-cli|core|
+  │                          elements|forms|http|language-service|localize|platform-browser|
+  │                          platform-browser-dynamic|platform-server|router|service-worker|
+  │                          upgrade|zone.js|packaging|changelog|docs-infra|migrations|
+  │                          devtools
+  │
+  └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test
+```
+
+The `<type>` and `<summary>` fields are mandatory, the `(<scope>)` field is optional.
+
+
+##### Type
+
+Must be one of the following:
+
+* **build**: Changes that affect the build system or external dependencies
+* **ci**: Changes to our CI configuration files and scripts (examples: CircleCi, SauceLabs)
+* **docs**: Documentation only changes
+* **feat**: A new feature
+* **fix**: A bug fix
+* **perf**: A code change that improves performance
+* **refactor**: A code change that neither fixes a bug nor adds a feature
+* **test**: Adding missing tests or correcting existing tests
+* **chore**: better not use
+
+##### Scope
+The scope should be the name of the npm package affected (as perceived by the person reading the changelog generated from commit messages).
diff --git a/README.md b/README.md
@@ -97,8 +97,13 @@ For additional usage examples, please explore the **[/examples](https://github.c
 
 You'll find a variety of scenarios showcasing the capabilities of Execution Engine.
 
+## Changelog 📝
+For a detailed list of changes, enhancements, and bug fixes, please refer to our [Changelog](CHANGELOG.md).
+
 # Contributing 🤝
 If you find any issues or have suggestions for improvement, feel free to open an issue or submit a pull request. Contributions are welcome!
 
+Before getting started, please read our [Contribution Guidelines](CONTRIBUTING.md).
+
 # License 📄
 This project is licensed under the MIT License - see the LICENSE file for details.
St.^❔	Category	Percentage	Covered / Total
🔴	Statements	57.95%	113/195
🔴	Branches	49.23%	64/130
🟡	Functions	63.16%	36/57
🔴	Lines	58.73%	111/189