Skip to content

Commit

Permalink
docs: improve contributing guide (#461)
Browse files Browse the repository at this point in the history
The aim of this change is to make contributions clearer to approach.
  • Loading branch information
iuioiua authored Sep 1, 2023
1 parent 0f61d35 commit a1386e9
Showing 1 changed file with 24 additions and 4 deletions.
28 changes: 24 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,29 @@
# Contributing

## Ways to Contribute

- Report bugs
- Implement performance improvements
- Refine documentation
- Suggest new features and design improvements
- Link to your SaaSKit-related project

## Creating an Issue

- Make sure that an issue doesn't already exist (avoid duplicates)
- Feel free to ask questions in the
[#saaskit Discord channel](https://discord.com/channels/684898665143206084/712010403302866974)

## Submitting a Pull Request

When submitting a pull request, please follow the
[Deno Style Guide](https://deno.land/manual/references/contributing/style_guide).
- Follow the
[Deno Style Guide](https://deno.land/manual/references/contributing/style_guide)
- A pull request must address a given issue. If an issue does not exist, create
one
- Tests must be provided for new functionality

## Design Rules

Before submitting a pull request, please run `deno task ok` and ensure all
checks pass. This checks formatting, linting, types and runs tests.
Follow
[CocoaPods design rules](https://github.com/CocoaPods/CocoaPods/wiki/Communication-&-Design-Rules#design-rules)
which apply to this project.

0 comments on commit a1386e9

Please sign in to comment.