Skip to content

Commit

Permalink
added CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fmerian authored Dec 5, 2023
1 parent 9e91377 commit 558c606
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Contributing

So you want to contribute to this repo? Awesome!

We welcome every contribution. To do so, you have two options:

1. [Create an issue](#create-an-issue) or
2. [Open a Pull Request (PR)](#open-a-pull-request)

## Create an issue

There are multiple ways to create an issue. Below is how to create an issue from the repository. For more information, see "[Creating an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue)."

1. Go to [supabase-community/launchweek.dev](https://github.com/supabase-community/launchweek.dev)
2. Under the repository name, click **Issues**
3. Click **New issue**
4. In the "Title" field, type a title for your issue, e.g. `Add {product} Launch Week`
6. In the comment body field, type a description of your issue
7. When you're finished, click **Submit new issue**

## Open a Pull Request

For more information, see "[Creating a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)."

## Additional notes

Some guidelines:

- Add one launch week per PR
- Make sure the PR title is in the following format: `Add {product} Launch Week`
- Add the launch week:
```
- YYYY / MM / DD-DD: {product} Launch Week. {links}
```
- Add links:
- Social posts:
`[Teaser ↗︎](https://)`
`[Read the thread ↗︎](https://)`
- Blog posts:
`[Read the announcement ↗︎](https://)`
`[Read the recap ↗︎](https://)`
- Launch page:
`[Go to launch page ↗︎](https://)`
- Check your spelling and grammar
- Remove any trailing whitespace
- Content must be in English

Thank you for making this repo more awesome! Enjoy!

0 comments on commit 558c606

Please sign in to comment.