feat: 🎸 CONTRIBUTING, issue template, pr, prettier format

Updated text and link in CONTRIBUTING.md, updated issue template with
development workflow link, updated pr template with development workflow
mention, run prettier to fromat  files

BREAKING CHANGE: 🧨 N

✅ Closes: #256

Author: codingwithmanny

.github/ISSUE_TEMPLATE/docs_issue.yml

@@ -6,6 +6,8 @@ body:
       value: |
         Thank you for submitting a documentation request. It helps make Berachain better.
 
+        PLEASE make sure you've read [Development Workflow](https://github.com/berachain/docs/blob/main/CONTRIBUTING.md#development-workflow) and have read and understood the [CODE OF CONDUCT](https://github.com/berachain/docs/blob/main/CODE_OF_CONDUCT.md).
+
         If it's a small change, like misspelling or example that needs updating, feel free to submit a PR instead of creating this issue.
 
   - type: dropdown

.github/pull_request_template.md

@@ -12,6 +12,9 @@ Closes #1
 
 ## Contribution
 
+- [ ] I have followed the [Development Workflow](https://github.com/berachain/docs/blob/main/CONTRIBUTING.md#development-workflow)
+- [ ] I have read the [CODE OF CONDUCT](https://github.com/berachain/docs/blob/main/CODE_OF_CONDUCT.md)
+
 Let us know your wallet address/ENS:
 
 ```

CONTRIBUTING.md

@@ -8,31 +8,31 @@ Berachain Foundation has adopted the [Contributor Covenant](https://www.contribu
 
 ## Open Development
 
-All work on Berachain Docs happens directly on [GitHub](https//github.com/berachain/docs). Both core team members and external contributors send pull requests which go through the same review process.
+All work on Berachain Docs happens directly on [GitHub](https://github.com/berachain/docs). Both core team members and external contributors send pull requests which go through the same review process.
 
 ## Semantic Versioning
 
 Berachain Docs follows [semantic versioning](https://semver.org). We release patch versions for critical bugfixes, minor versions for new features or non-essential changes, and major versions for any breaking changes. When we make breaking changes, we also introduce deprecation warnings in a minor version so that our users learn about the upcoming changes and migrate their code in advance. Learn more about our commitment to stability and incremental migration in our versioning policy.
 
 ### TL;DR SemVer
 
-**Version Bump Required**
+**Typical Version Bump Scenarios**
 
 - Changes to components `./packages/ui`
 - Changes to constatns `./packages/config`
 - Changes to docs structure via sidebar, theme, images, vercel configs, etc
   - `./apps/*/.vitepress/*`
   - `./apps/*/content/public/*`
 
-**_NO_ Version Bump Required**
+**_Minor_ Version Bump Scenario**
 
 - Text and typo changes in markdown files (\*.md)
 
 ## Branch Organization
 
-Submit all changes directly to the [main branch](https://github.com/berachain/docs/tree/main). We don't use separate branches for development or for upcoming releases. We do our best to keep main in good shape, with all tests passing. Please always make sure to fork the repository for external contributions.
+Submit all changes as a pull request directly to the [main branch](https://github.com/berachain/docs/tree/main). We don't use separate branches for development or for upcoming releases. We do our best to keep main in good shape. Please always make sure to fork the repository for external contributions.
 
-Code that lands in main must be compatible with the latest stable release. It may contain additional features, but no breaking changes. We should be able to release a new minor version from the tip of main at any time.
+Code that lands in main must be compatible with all apps and packages. It may contain additional features, but no breaking changes. We should be able to release a new minor version from the tip of main at any time.
 
 ## Bugs / Issues
 
@@ -55,7 +55,7 @@ Berachain Foundation has a process for the safe disclosure of security bugs. Wit
 
 ## Proposing a Change
 
-If you intend to change the core frontend, or make any non-trivial changes to the implementation, we recommend [filing an issue](https://github.com/berachain/docs/issues/new). This lets us reach an agreement on your proposal before you put significant effort into it.
+If you intend to change the core frontend, or make any non-trivial changes to the implementation, we recommend [filing an issue](https://github.com/berachain/docs/issues/new/choose). This lets us reach an agreement on your proposal before you put significant effort into it.
 
 If you're only fixing a bug or a typo, it's fine to submit a pull request right away but we still recommend to file an issue detailing what you're fixing. This is helpful in case we don't accept that specific fix but want to keep track of the issue.
 
@@ -65,7 +65,7 @@ Working on your first Pull Request? You can learn how from this free video serie
 
 [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
 
-To help you get your feet wet and get you familiar with our contribution process, we have a list of good first issues that contain bugs that have a relatively limited scope. This is a great place to get started.
+To help you get familiar with our contribution process, we have a list of good first issues that contain bugs that have a relatively limited scope. This is a great place to get started.
 
 If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don't accidentally duplicate your effort.
 
@@ -75,11 +75,7 @@ If somebody claims an issue but doesn't follow up for more than two weeks, it's
 
 The core team is monitoring for pull requests. We will review your pull request and either merge it, request changes to it, or close it with an explanation. We'll do our best to provide updates and feedback throughout the process.
 
-**Before submitting a pull request**, please make sure the following is done:
-
-1. Fork [the repository](https://github.com/berachain/docs) and create your branch from main.
-2. Run `pnpm` in the repository root to install dependencies.
-3. Format your code with prettier (`pnpm format`) from the root.
+**Before submitting a pull request**, please make sure to see [Development Workflow](#development-workflow).
 
 ## Contribution Prerequisites
 
@@ -131,9 +127,9 @@ pnpm -v;
 If the versions are not correct or you don't have Node.js or Pnpm installed, download and follow their setup instructions:
 
 - Install Node.js using [fnm](https://github.com/Schniz/fnm) or from the [official website](https://nodejs.org/)
-- Install[Pnpm](https://pnpm.io/installation)
+- Install [Pnpm](https://pnpm.io/installation)
 
-With `nvm` or `fnm`
+To install the required Node.js version use `nvm` or `fnm`:
 
 ```bash
 # FROM: ./docs
@@ -152,11 +148,11 @@ This will install all dependencies in all `./apps` and `./packages` folders.
 pnpm install;
 ```
 
-> **NOTE:** Alternatively you if you have `node_modules` conflicts, you can run `pnpm clean` which will remove all node_modules, caching, and turbo folders, for a fresh install.
+> **NOTE:** Alternatively if you have `node_modules` conflicts, you can run `pnpm clean` which will remove all node modules, caching, and turbo folders, for a fresh install.
 
 ### Running different sites
 
-To run all sites at once, you simply run the following command.
+To run all sites at once, you can simply run the following command.
 
 ```bash
 # FROM: ./docs

apps/bend/.vitepress/config.ts

@@ -138,49 +138,55 @@ export default defineConfig({
         {
           find: /^.*\/VPNavBar\.vue$/,
           replacement: fileURLToPath(
-            new URL("../node_modules/@berachain/ui/NavBar.vue", import.meta.url)
+            new URL(
+              "../node_modules/@berachain/ui/NavBar.vue",
+              import.meta.url,
+            ),
           ),
         },
         {
           find: /^.*\/VPNavBarMenu\.vue$/,
           replacement: fileURLToPath(
             new URL(
               "../node_modules/@berachain/ui/NavBarMenu.vue",
-              import.meta.url
-            )
+              import.meta.url,
+            ),
           ),
         },
         {
           find: /^.*\/VPNavBarMenuLink\.vue$/,
           replacement: fileURLToPath(
             new URL(
               "../node_modules/@berachain/ui/NavBarMenuLink.vue",
-              import.meta.url
-            )
+              import.meta.url,
+            ),
           ),
         },
         {
           find: /^.*\/VPNavScreenMenuGroup\.vue$/,
           replacement: fileURLToPath(
             new URL(
               "../node_modules/@berachain/ui/NavScreenMenuGroup.vue",
-              import.meta.url
-            )
+              import.meta.url,
+            ),
           ),
         },
         {
           find: /^.*\/VPFlyout\.vue$/,
           replacement: fileURLToPath(
-            new URL("../node_modules/@berachain/ui/Flyout.vue", import.meta.url)
+            new URL(
+              "../node_modules/@berachain/ui/Flyout.vue",
+              import.meta.url,
+            ),
           ),
         },
         {
           find: /^.*\/VPSidebar\.vue$/,
           replacement: fileURLToPath(
             new URL(
               "../node_modules/@berachain/ui/Sidebar.vue",
-              import.meta.url
-            )
+              import.meta.url,
+            ),
           ),
         },
       ],

apps/bend/content/developers/guides/delegate-credits.md

@@ -30,7 +30,7 @@ To approve delegation, the approveDelegation method of the debt token contract i
 import { ethers } from "ethers";
 
 const provider = new ethers.providers.JsonRpcProvider(
-  "https://bartio.rpc.berachain.com"
+  "https://bartio.rpc.berachain.com",
 );
 const signer = new ethers.Wallet("YOUR_PRIVATE_KEY", provider);
 
@@ -44,14 +44,14 @@ const debtTokenAbi = [
 const debtTokenContract = new ethers.Contract(
   debtTokenAddress,
   debtTokenAbi,
-  signer
+  signer,
 );
 
 async function approveDelegation() {
   try {
     const tx = await debtTokenContract.approveDelegation(
       delegationAddress,
-      amount
+      amount,
     );
     await tx.wait();
     console.log(`Delegation approved: ${tx.hash}`);
@@ -81,7 +81,7 @@ The borrower's available credit is reduced by the borrowed amount.
 import { ethers } from "ethers";
 
 const provider = new ethers.providers.JsonRpcProvider(
-  "https://bartio.rpc.berachain.com"
+  "https://bartio.rpc.berachain.com",
 );
 const signer = new ethers.Wallet("YOUR_PRIVATE_KEY", provider);
 
@@ -100,7 +100,7 @@ async function getPoolAddress(): Promise<string> {
   const lendingPoolAddressesProvider = new ethers.Contract(
     poolAddressesProvider,
     poolAddressesProviderAbi,
-    provider
+    provider,
   );
   return await lendingPoolAddressesProvider.getPool();
 }
@@ -111,15 +111,15 @@ async function borrow() {
     const lendingPoolContract = new ethers.Contract(
       lendingPoolAddress,
       lendingPoolAbi,
-      signer
+      signer,
     );
 
     const tx = await lendingPoolContract.borrow(
       assetAddress,
       borrowAmount,
       2, // variable interest rate
       0,
-      DELEGATOR_ADDRESS
+      DELEGATOR_ADDRESS,
     );
     await tx.wait();
     console.log(`Borrowed: ${tx.hash}`);

apps/bend/content/developers/guides/liquidate-loan.md

@@ -53,7 +53,7 @@ import { ethers } from "ethers";
 
 // connect to Berachain using the provided rpc url
 const provider = new ethers.providers.JsonRpcProvider(
-  "https://bartio.rpc.berachain.com"
+  "https://bartio.rpc.berachain.com",
 );
 
 // replace with your wallet's private key
@@ -83,12 +83,12 @@ async function liquidateLoan() {
       debtAssetAddress, // the debt asset we're covering
       userAddress, // the user whose loan is being liquidated
       debtToCover, // amount of debt to cover
-      false // set to true if you want to receive aTokens instead of the underlying asset
+      false, // set to true if you want to receive aTokens instead of the underlying asset
     );
 
     await tx.wait();
     console.log(
-      `liquidation performed successfully! transaction hash: ${tx.hash}`
+      `liquidation performed successfully! transaction hash: ${tx.hash}`,
     );
   } catch (error) {
     console.error("there was an error performing the liquidation:", error);

apps/bend/content/developers/guides/repay-loan.md

@@ -15,7 +15,7 @@ import { ethers } from "ethers";
 
 // Connect to Berachain using the provided RPC URL
 const provider = new ethers.providers.JsonRpcProvider(
-  "https://bartio.rpc.berachain.com"
+  "https://bartio.rpc.berachain.com",
 );
 const signer = new ethers.Wallet("YOUR_PRIVATE_KEY", provider);
 
@@ -45,7 +45,7 @@ async function repayLoan() {
       honeyAddress,
       repayAmount,
       2, // variable interest rate
-      signer.address // repaying loan on behalf of this user
+      signer.address, // repaying loan on behalf of this user
     );
     await tx.wait();
     console.log(`Repaid: ${tx.hash}`);

apps/bend/content/developers/guides/retrieve-interest-rates.md

@@ -18,7 +18,7 @@ Below is an example for fetching interest rates on Bend
 import { ethers } from "ethers";
 
 const provider = new ethers.providers.JsonRpcProvider(
-  "https://bartio.rpc.berachain.com"
+  "https://bartio.rpc.berachain.com",
 );
 const poolAddressesProvider = "0x8297A07f87a8576b88d46e636c05B84E4Ea8265D";
 
@@ -138,7 +138,7 @@ async function fetchInterestRates() {
   const poolAddressesProvider = new ethers.Contract(
     poolAddressesProvider,
     poolAddressesProviderAbi,
-    provider
+    provider,
   );
   const lendingPoolAddress = await poolAddressesProvider.getPool();
   const lendingPool = new ethers.Contract(poolAddress, poolAbi, provider);
@@ -147,10 +147,10 @@ async function fetchInterestRates() {
     await lendingPool.getReserveData(assetAddress);
 
   console.log(
-    `$HONEY Supply APY: ${ethers.utils.formatUnits(liquidityRate, 27)}%`
+    `$HONEY Supply APY: ${ethers.utils.formatUnits(liquidityRate, 27)}%`,
   );
   console.log(
-    `$HONEY Borrow APY: ${ethers.utils.formatUnits(variableBorrowRate, 27)}%`
+    `$HONEY Borrow APY: ${ethers.utils.formatUnits(variableBorrowRate, 27)}%`,
   );
 }
 

apps/berps/.vitepress/config.ts

@@ -135,49 +135,55 @@ export default defineConfig({
         {
           find: /^.*\/VPNavBar\.vue$/,
           replacement: fileURLToPath(
-            new URL("../node_modules/@berachain/ui/NavBar.vue", import.meta.url)
+            new URL(
+              "../node_modules/@berachain/ui/NavBar.vue",
+              import.meta.url,
+            ),
           ),
         },
         {
           find: /^.*\/VPNavBarMenu\.vue$/,
           replacement: fileURLToPath(
             new URL(
               "../node_modules/@berachain/ui/NavBarMenu.vue",
-              import.meta.url
-            )
+              import.meta.url,
+            ),
           ),
         },
         {
           find: /^.*\/VPNavBarMenuLink\.vue$/,
           replacement: fileURLToPath(
             new URL(
               "../node_modules/@berachain/ui/NavBarMenuLink.vue",
-              import.meta.url
-            )
+              import.meta.url,
+            ),
           ),
         },
         {
           find: /^.*\/VPNavScreenMenuGroup\.vue$/,
           replacement: fileURLToPath(
             new URL(
               "../node_modules/@berachain/ui/NavScreenMenuGroup.vue",
-              import.meta.url
-            )
+              import.meta.url,
+            ),
           ),
         },
         {
           find: /^.*\/VPFlyout\.vue$/,
           replacement: fileURLToPath(
-            new URL("../node_modules/@berachain/ui/Flyout.vue", import.meta.url)
+            new URL(
+              "../node_modules/@berachain/ui/Flyout.vue",
+              import.meta.url,
+            ),
           ),
         },
         {
           find: /^.*\/VPSidebar\.vue$/,
           replacement: fileURLToPath(
             new URL(
               "../node_modules/@berachain/ui/Sidebar.vue",
-              import.meta.url
-            )
+              import.meta.url,
+            ),
           ),
         },
       ],

apps/berps/content/developers/guides/close-trade.md

@@ -43,7 +43,7 @@ const signer = new ethers.Wallet(YOUR_PRIVATE_KEY, ETHERS_PROVIDER);
 const tradingContract = new ethers.Contract(
   ENTRYPOINT_CONTRACT_ADDRESS,
   EntrypointContractABI,
-  signer
+  signer,
 );
 const pythConnection = new EvmPriceServiceConnection(PYTH_ENDPOINT);
 ```
@@ -63,7 +63,7 @@ const priceUpdateData = await pythConnection.getPriceFeedsUpdateData([
 const tx = await tradingContract.closeTradeMarket(
   TRADE_INDEX, // Index of the trade to close
   priceUpdateData,
-  { value: 2 }
+  { value: 2 },
 );
 ```