|
|
@@ -1,6 +1,18 @@
|
|
|
# Contribution Guidelines
|
|
|
|
|
|
-### Commit message format
|
|
|
+Hi! Thank you for taking the time to contribute to Vendure!
|
|
|
+
|
|
|
+In order to make the best use of both your time and that of the Vendure maintainers, please follow the guidelines in this document.
|
|
|
+
|
|
|
+## Bug Fixes
|
|
|
+
|
|
|
+If you would like to contribute a bugfix, please first create an issue detailing the bug, and also indicate that you intend to fix it. When creating commits, please follow the commit message format below.
|
|
|
+
|
|
|
+## New Features
|
|
|
+
|
|
|
+Again, please create a feature request detailing the functionality you intend to add, and state that you would like to implement it. When creating commits, please follow the commit message format below.
|
|
|
+
|
|
|
+## Commit message format
|
|
|
|
|
|
This repo uses [Conventional Commits](https://www.conventionalcommits.org).
|
|
|
|
|
|
@@ -11,6 +23,7 @@ type(scope): Message in present tense
|
|
|
* **feat** (new feature)
|
|
|
* **fix** (bug fix)
|
|
|
* **docs** (changes to documentation)
|
|
|
+* **perf** (performance improvements)
|
|
|
* **style** (formatting, missing semi colons, etc; no code change)
|
|
|
* **refactor** (refactoring production code)
|
|
|
* **test** (adding missing tests, refactoring tests; no production code change)
|