diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b5c68affe..11509aa2f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,7 +20,7 @@ We follow a specific branching model to organize our development process. Please ### **Feature branches** -Feature branches should have one of the following prefixes: fix (bug fix), ft (feature), ht (hotfix), chore, or doc (documentation), followed by a forward slash and a descriptive name. +Feature branches should have one of the following prefixes: fix (bug fix), ft (feature), ht (hotfix), chore, doc (documentation), or test(testing) followed by a forward slash and a descriptive name. **Examples:** @@ -29,6 +29,7 @@ Feature branches should have one of the following prefixes: fix (bug fix), ft (f - ht/emergency-fix - chore/update-dependencies - doc/update-readme +- test/add-unit-tests ### Commit @@ -51,7 +52,7 @@ Feature branches should have one of the following prefixes: fix (bug fix), ft (f ```bash # Good practice git commit -m "chore: update dependencies" - git commit -m "doc: improve documentation" + git commit -m "docs: improve documentation" # Avoid combining unrelated changes git commit -m "chore: update dependencies and fix bug" diff --git a/README.md b/README.md index f8911789e..9c3dabdfc 100644 --- a/README.md +++ b/README.md @@ -76,27 +76,27 @@ yarn install Before running the application locally, the following environment variables are required to be set: ```js -NEXT_PUBLIC_FIREBASE_API_KEY = "AIzaSyAmodim2lJZBradsjx6Zl98hECO7vpo2To"; -NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN = "dacade-d02d2.firebaseapp.com"; -NEXT_PUBLIC_FIREBASE_PROJECT_ID = "dacade-d02d2"; -NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID = "${config.measurementId}"; -NEXT_PUBLIC_FIREBASE_APP_ID = "1:194074425069:web:e519dce8d78a458d8b3ee4"; +NEXT_PUBLIC_FIREBASE_API_KEY = "AIzaSyAmodim2lJZBradsjx6Zl98hECO7vpo2To" +NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN = "dacade-d02d2.firebaseapp.com" +NEXT_PUBLIC_FIREBASE_PROJECT_ID = "dacade-d02d2" +NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID = "${config.measurementId}" +NEXT_PUBLIC_FIREBASE_APP_ID = "1:194074425069:web:e519dce8d78a458d8b3ee4" -NEXT_PUBLIC_API_BASE_URL = "https://us-central1-dacade-d02d2.cloudfunctions.net/api"; +NEXT_PUBLIC_API_BASE_URL = "https://us-central1-dacade-d02d2.cloudfunctions.net/api" -NEXT_PUBLIC_BUGSNAG_API_KEY = ""; -NEXT_PUBLIC_SHOW_LANGUAGE_SELECTOR = true; +NEXT_PUBLIC_BUGSNAG_API_KEY = "" +NEXT_PUBLIC_SHOW_LANGUAGE_SELECTOR = true -NEXT_PUBLIC_DISCORD_CLIENT_ID = ""; -NEXT_PUBLIC_DISCORD_CALLBACK_URL = "https://us-central1-dacade-d02d2.cloudfunctions.net/api/discord-bot/oauth/callback"; -NEXT_PUBLIC_DISCORD_OAUTH_BASE_URL = "https://discord.com/api/oauth2/authorize"; -NEXT_PUBLIC_DISCORD_SCOPE = "identify email"; +NEXT_PUBLIC_DISCORD_CLIENT_ID = "" +NEXT_PUBLIC_DISCORD_CALLBACK_URL = "https://us-central1-dacade-d02d2.cloudfunctions.net/api/discord-bot/oauth/callback" +NEXT_PUBLIC_DISCORD_OAUTH_BASE_URL = "https://discord.com/api/oauth2/authorize" +NEXT_PUBLIC_DISCORD_SCOPE = "identify email" -NEXT_PUBLIC_GOOGLE_TRANSLATE_API_KEY = ""; +NEXT_PUBLIC_GOOGLE_TRANSLATE_API_KEY = "" -NEXT_PUBLIC_BLOCK_EXPLORER_URL = "https://alfajores.celoscan.io"; +NEXT_PUBLIC_BLOCK_EXPLORER_URL = "https://alfajores.celoscan.io" -NEXT_PUBLIC_IPFS_URL = "https://gateway.pinata.cloud/ipfs/"; +NEXT_PUBLIC_IPFS_URL = "https://gateway.pinata.cloud/ipfs/" ``` ### 4. Run App