Skip to content

Commit

Permalink
docs: update docs to explain how to contribute
Browse files Browse the repository at this point in the history
  • Loading branch information
hiporox committed May 7, 2024
1 parent cc8cb00 commit d6bd524
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ a protocol for decentralized social apps: https://www.farcaster.xyz
d. launch local copy of Supabase with `supabase start`, use the info provided -> <br>
`API URL`:`NEXT_PUBLIC_SUPABASE_URL` + `anon key`:`NEXT_PUBLIC_SUPABASE_ANON_KEY`

## Contributing and making Fidgets

See the [contributing docs](docs/CONTRIBUTING.MD) for how to add to the code base.

## Code Design

The Nounspace App follows the Atomic Design Pattern
Expand Down
26 changes: 26 additions & 0 deletions docs/CONTRIBUTING.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Contributing

To add any code to the `nounspace/Nounspace.ts` repo, you will need to open a PR.

## Typescript
Nounspace is written fully in typescript. At time of writing this (5/7/24), we are still in the process of fixing type errors that exist from the original codebase.

## Steps to open a PR
Nounspace expects its contibutors to follow the "Fork and Pull" method to open PRs. Bellow is a TL;DR for this process

1. Fork `nounspace/Nounspace.ts`
a. Press the `fork` button at the top of the page
b. Copy the fork locally (`git clone {your url}`)
c. Set up the `upstream` to `nounspace/Nounspace.ts` (`git remote add upstream [email protected]:Nounspace/nounspace.ts.git`)
2. Make changes in your fork
3. Commit your changes to your fork and push them to Github
4. Open a PR in the Github webapp

For more details on the "Fork and Pull" method, check out [Github's docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models).


## PR Expectations
- All commits follow [conventional commits](https://www.conventionalcommits.org/)
- PR's titles begin with either "[FIDGET]" or "[CLIENT]" to show if the changes made are a Fidget submission or a change to the client code base
- PR's bodies outline the changes made, and the rationale for them.
- All PR's contain no new type errors and are fully valid typescript code

0 comments on commit d6bd524

Please sign in to comment.