diff --git a/.changeset/gold-mangos-tell.md b/.changeset/gold-mangos-tell.md new file mode 100644 index 0000000..b5dcef6 --- /dev/null +++ b/.changeset/gold-mangos-tell.md @@ -0,0 +1,6 @@ +--- +'@inkathon/contracts': patch +'@inkathon/frontend': patch +--- + +Add contributor guidelines at `CONTRIBUTING.md`. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..8ae6771 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,42 @@ +# Contributor Guidelines + +[Scio Labs](https://scio.xyz) actively welcomes contributions from anyone to make this a community-driven effort. There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, or writing code. + +Our ink! developer tooling initiative is made up of the following projects: + +- `create-ink-app` CLI (_Coming soon_) +- [`ink!athon`](https://github.com/scio-labs/inkathon) Boilerplate +- [`useInkathon`](https://github.com/scio-labs/use-inkathon) Hooks & Utility Library +- [`zink!`](https://github.com/scio-labs/zink) Smart Contract Macros + +_To ensure a smooth and efficient collaboration, please follow the guidelines below._ + +## Issues + +- Before starting work, please check the existing issues for your planned feature or bug fix. +- If there isn't an existing issue, create one. This allows us to avoid duplicate work and discuss the implementation details upfront. +- If you want to work on an issue, please comment on it to let us know. This helps us keep track of who is working on what. + +## Pull Requests + +- All changes should be made through pull requests (PRs). +- Please ensure your PR is linked to the relevant issue. +- Include a clear and detailed description of the changes in your PR. +- Request a review once your PR is ready. + +## Code Style + +- Please follow the existing coding style. +- Make sure your changes pass the lint checks. + +> [!NOTE] +> It's recommended to enable the `pre-commit` hook in your local repository via `pnpm simple-git-hooks`. Also, please always use the `inkathon.code-workspace` file when working on the project in VSCode. + +## Communication + +- Be respectful and considerate in all interactions. +- If you have questions or need help, don't hesitate to ask. +- For code, feature, or bug discussions, please use the relevant GitHub issue or PR. +- To chat with us or ask questions, join our [Telegram Group](https://t.me/inkathon). 💬 + +Thanks for your contributions! 🙏 diff --git a/README.md b/README.md index ff64d66..3b5cec8 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,8 @@ Other projects include: **Join the discussion in our [Telegram Group](https://t.me/inkathon)** 💬 +**If you want to contribute, please read our [Contributor Guidelines](https://github.com/scio-labs/inkathon/blob/main/CONTRIBUTING.md)** 🙏 + --- **Table of Contents:** @@ -229,6 +231,8 @@ When running the same script again, this deployer account defined there will be It's recommended to develop in VSCode by opening the workspace file `inkathon.code-workspace` instead of just the plain directory. This approach offers multiple advantages, including a more predictable monorepo configuration. VSCode will also automatically suggest switching to the workspace when opening the project's root directory in the bottom right corner. +VSCode Workspace Notification + ### Plugins Additionally, the VSCode plugins listed below are recommended as they can be very helpful when working with this boilerplate. diff --git a/inkathon-vscode-workspace.png b/inkathon-vscode-workspace.png new file mode 100644 index 0000000..4e4a902 Binary files /dev/null and b/inkathon-vscode-workspace.png differ