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.

Sign up for GitHub

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

Jump to bottom

Create CONTRIBUTING.md #3

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Create CONTRIBUTING.md #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Hello! Thank you for your interest in contributing to `effect-use`.

## Adding a new package
1. Copy an existing one
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be good to have a template package or to specify which one to copy that doesn't have too much code to remove.

2. Paste it and rename the folder
3. `yarn constraints --fix`
4. Some work...
5. Open a pull request

Please ensure the package follows the following form:

<your-package>/index.ts
```typescript
export const MyAPIId = '@effect/use/<my-name>' as const
export type MyAPI = <my-api-type>
export const MyAPI = Context.Tag<MyAPI>(MyAPIId)
```