Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add CONTRIBUTING and SUPPORT files #815

Merged
merged 8 commits into from
May 15, 2024

Conversation

dasanra
Copy link
Collaborator

@dasanra dasanra commented May 13, 2024

What it solves

Adds CONTRIBUTING and SUPPORT files in order to guide developers how to use this repository.

Adds many more links to the docs so the reference is easier to find.

  • In the CONTRIBUTING we ask devs not to open issues for usability questions and redirect them to the SUPPORT file.
  • In the SUPPORT file we explain that the main source of information after the docs should be Stack Exchange and explain how to add a question there.
  • In the CONTRIBUTING we explain how to use the monorepo (install dependencies, build the project...)
  • Link CONTRIBUTING and SUPPORT on each package README.
  • Remove API reference from protocol-kit and api-kit README

@dasanra dasanra requested a review from yagopv May 14, 2024 09:43
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
guides/README.md Show resolved Hide resolved
packages/api-kit/README.md Show resolved Hide resolved
packages/protocol-kit/README.md Outdated Show resolved Hide resolved
@dasanra dasanra merged commit 907fe87 into Abitype-1_3_0-safe-contract May 15, 2024
9 of 19 checks passed
@dasanra dasanra deleted the update-readmes branch May 15, 2024 11:39
@github-actions github-actions bot locked and limited conversation to collaborators May 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants