📝 Improve repository structure (#21)

GabrielePicco · web-flow · commit afac26c1e076 · 2024-02-28T10:23:16.000+01:00
* 📝 Add Contributing and code of conduct

* 📝 Update Readme.md

* ♻️ Refactor args
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dev@magicblock.gg. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,53 @@
+# Contributing
+
+Thank you for considering contributing to [Bolt](https://github.com/magicblock-labs/bolt)!
+
+When contributing, please first discuss the change you wish to make via [issue](https://github.com/magicblock-labs/bolt/issues), or any other method with the owners of this repository before making a change.
+
+Note that we have a [Code of Conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
+
+## Setup
+
+1. Fork this repository and create your branch from `main`.
+
+2. Clone your forked repository.
+
+```sh
+git clone https://github.com/{username}/bolt && cd bolt
+```
+
+3. Make sure that you have [Rust](https://www.rust-lang.org/) `1.64.0` or later installed and build the project.
+
+```sh
+cargo build
+```
+
+4. Start committing your changes. Follow the [conventional commit specification](https://www.conventionalcommits.org/) and [gitmoji specification](https://gitmoji.dev/specification) while doing so.
+
+5. Add your tests (if you haven't already) or update the existing tests according to the changes. And check if the tests are passed.
+
+```sh
+cargo test
+```
+
+6. Make sure [rustfmt](https://github.com/rust-lang/rustfmt) and [clippy](https://github.com/rust-lang/rust-clippy) don't complain about your changes.
+
+
+## Create a Pull Request
+
+1. Ensure that you updated the documentation and filled the [Pull Request template](./.github/PULL_REQUEST_TEMPLATE.md) according to the changes you made.
+
+2. Wait for approval from the project owner/maintainer. Discuss the possible changes and update your Pull Request if necessary.
+
+3. You may merge the Pull Request once you have the sign-off of the project owner/maintainer, or if you do not have permission to do that, you may request the project owner/maintainer to merge it in case they haven't done it after a while.
+
+## Release Process
+
+1. Create a branch from `main` with the name `release/vX.Y.Z` where `X.Y.Z` is the new version number.
+2. Create a Pull Request from the `release/vX.Y.Z` branch to `main`. The PR will trigger CI/CD pipeline to check if the release is ready.
+3. Once the PR is approved and the CI/CD pipeline is successful, merge the PR to `main`.
+4. Create a new release on GitHub with the new version number and the release notes. CI/CD pipeline will automatically publish the new release to [crates.io](https://crates.io/), publish the binaries and the packages to npmjs.
+
+# License
+
+By contributing, you agree that your contributions will be licensed under [The MIT License](./LICENSE-MIT) or [Apache License 2.0](./LICENSE-APACHE).
diff --git a/README.md b/README.md
@@ -18,11 +18,40 @@
 
 </div>
 
-Bolt is a high-performance and composable SVM-based framework designed to scale Fully On Chain (FOC) Games and Autonomous Worlds. 
+Bolt is a high-performance, scalable SVM-based framework designed for Fully On Chain (FOC) Games and Autonomous Worlds.
 
-## ⚡️ Early sign-ups
+With Bolt, you can create games that live forever on the blockchain. These games are platform-centric by default, empowering users to extend and modify both game content and logic. Bolt facilitates multiplayer gaming experiences with performances on pair with traditional multiplayer servers.
 
-[Form](https://i4a385hjc2e.typeform.com/to/pAFHn2mI)
+Furthermore, the framework incorporates an Entity Component System (ECS) architecture, streamlining the game structuring and assembly process and providing ready-to-use components. Developers can reuse and contribute modules and logic deployed on the blockchain.
+
+## Packages
+
+| Package                     | Description                                                                      | Version                                                                                                                                  | Docs                                                                                                            |
+|:----------------------------|:---------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------|
+| `bolt-lang`                 | Rust primitives for creanting components, systems and writing programs on Solana | [![Crates.io](https://img.shields.io/crates/v/bolt-lang?color=blue)](https://crates.io/crates/bolt-lang)                                 | [![Docs.rs](https://img.shields.io/badge/docs-tutorials-blue)](https://book.boltengine.gg/)                                    |
+| `@magicblock-labs/bolt-sdk` | TypeScript client for Anchor programs                                            | [![npm](https://img.shields.io/npm/v/@magicblock-labs/bolt-sdk.svg?color=blue)](https://www.npmjs.com/package/@coral-xyz/anchor)         | [![Docs](https://img.shields.io/badge/docs-tutorials-blue)](https://book.boltengine.gg/getting_started/world_program.html#typescript-sdk-installation)     |
+| `@magicblock-labs/bolt-cli` | CLI to support building and managing a Bolt workspace                            | [![npm](https://img.shields.io/npm/v/@magicblock-labs/bolt-cli.svg?color=blue)](https://www.npmjs.com/package/@magicblock-labs/bolt-cli) | [![Docs](https://img.shields.io/badge/docs-tutorials-blue)](https://book.boltengine.gg/getting_started/installation.html) |
+
+## ⚡️ Installing the bolt-cli
+
+```bash
+npm install -g @magicblock-labs/bolt-cli
+```
+
+## 🔩️ Getting Started
+
+Create a project with the bolt-cli:
+
+```bash
+bolt init new-project
+```
+
+Run the tests for the generated example project:
+
+```bash
+cd new-project
+bolt test
+```
 
 ## 📘 Bolt book
 
@@ -32,8 +61,18 @@ Read the Bolt book: [book.boltengine.gg](https://book.boltengine.gg/)
 
 Read the Bolt whitepaper for a detailed overview on the architecture and the scalability solution: [Ephemeral Rollups are All you Need](https://arxiv.org/abs/2311.02650)
 
-## 🚧 Warning: under costruction
+## 🚧 Under construction
+
+Bolt is in active development, so all APIs are subject to change.
+This code is unaudited. Use at your own risk.
+
+## 💚 Open Source
+
+Open Source is at the heart of what we do at Magicblock. We believe building software in the open, with thriving communities, helps leave the world a little better than we found it.
+
 
-Bolt is an open-source project, currently in its early development phase and subject to frequent changes as we are still working on wiring up the final system. We warmly welcomes contributors. For additional resources, join the community on [Discord](https://discord.com/invite/MBkdC3gxcv).
+## ✨ Contributors & Community
 
+Thank you for your interest in contributing to Bolt!
+Please see the [CONTRIBUTING.md](./CONTRIBUTING.md) to learn how.
 
diff --git a/cli/src/rust_template.rs b/cli/src/rust_template.rs
@@ -74,7 +74,7 @@ declare_id!("{}");
 #[system]
 pub mod {} {{
 
-    pub fn execute(ctx: Context<Components>, args_p: Vec<u8>) -> Result<Components> {{
+    pub fn execute(ctx: Context<Components>, _args_p: Vec<u8>) -> Result<Components> {{
         let position = &mut ctx.accounts.position;
         position.x += 1;
         position.y += 1;
