63 align with open source checklist

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Contributor Guidelines
+
+Thank you for considering contributing to our project! We welcome your contributions and value the community's input. To
+ensure a smooth collaboration, please follow these guidelines:
+
+## Submitting a Bug Report
+
+-   Search the [issue tracker](https://github.com/vechainfoundation/vechain-dapp-kit/issues) to ensure that the bug has
+    not been reported already.
+-   If the bug has not been reported, create a new issue with a descriptive title and a clear description of the bug.
+
+## Getting Started
+
+-   Fork the repository and clone it to your local machine.
+-   Install the necessary dependencies.
+
+## Making Changes
+
+-   Create a new branch for your changes.
+-   Make your changes and test them thoroughly.
+-   Follow the coding style and conventions used in the project (prettier, eslint).
+
+## Submitting Changes
+
+-   Commit your changes with clear and concise messages.
+-   Push your changes to your fork.
+-   Create a pull request with a detailed description of your changes.
+
+## Reporting Issues
+
+If you encounter any issues or have suggestions,
+please [open an issue](https://github.com/vechainfoundation/vechain-dapp-kit/issues) on GitHub.

README.md

@@ -3,6 +3,19 @@
 VeWorld WalletKit is a typescript library that facilitates seamless interaction between VeChain wallets (veworld, sync2)
 and dApps, enhancing user experience and developer convenience.
 
+## Table of Contents
+
+-   [Why ?](#why-)
+-   [Key features](#key-features)
+-   [Contributing](#contributing)
+-   [Sample Projects](#sample-projects)
+-   [Branching Strategy](#branching-strategy)
+-   [Setting up for local development](#setting-up-for-local-development)
+    -   [Prerequisites](#prerequisites)
+    -   [Install & build dependencies](#install--build-dependencies)
+    -   [Run in Dev Mode](#run-in-dev-mode)
+-   [Further Documentation & Usage](#further-documentation--usage)
+
 ## Why ?
 
 -   Allow easy interaction with all wallets.
@@ -29,7 +42,39 @@ Key Features a.k.a scope
 
     Easy to adopt with proper documentation.
 
-## Setting up the project (Common flow)
+---
+
+## Contributing
+
+-   Please refer to the [Contributing Guide](./CONTRIBUTING.md) for more information on how to contribute to the project.
+
+---
+
+## Sample Projects
+
+-   Please refer to the [apps](./apps) folder for sample projects.
+
+---
+
+## Branching Strategy
+
+Welcome to our project! Here's an overview of our branching strategy.
+
+---
+
+### Branch Types
+
+-   **main**: The main branch represents the production-ready code. Only stable and tested features should be merged into
+    this branch. Once ready for publishing, a new tag should be created from this branch.
+
+---
+
+## Setting up for local development
+
+### Prerequisites
+
+-   Node.js >= 18.17
+-   Yarn >= 1.22.10
 
 ### Install & build dependencies
 
@@ -45,6 +90,12 @@ yarn dev
 
 ## Useful scripts
 
+### Test
+
+```bash
+yarn test
+```
+
 ### Clean project
 
 ```bash
@@ -77,6 +128,9 @@ yarn build:deps
 yarn build
 ```
 
-### Future Work
+---
+
+## Further Documentation & Usage
 
--   Create a Modal/ Library in React / Vue / Angular
+-   Please refer to [Vechain Docs](https://docs.vechain.org/developer-resources/sdks-and-providers) for more information
+    on how to use the library.