Skip to content

Commit

Permalink
improve CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
clbrge committed Apr 10, 2023
1 parent 6a1e827 commit baa90e0
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,26 @@
# Contributing to svelte-web3

Thanks for your interest in improving svelte-web3! We welcome
contributions of all kinds: from discussion to documentation to
bugfixes to feature improvements.
Thank you for your interest in improving svelte-web3! We welcome contributions of all kinds: from discussions and documentation to bug fixes and feature enhancements.

Please review this document to help to streamline the process and save
everyone's precious time.
Please review this document to help streamline the process and save everyone's precious time.

## Issues

No software is bug-free. So, if you got an issue, follow these steps:
No software is bug-free. If you encounter an issue, follow these steps:

- Search the [issue list](https://github.com/clbrge/svelte-web3/issues) for current and old issues.
- If you find an existing issue, please UPVOTE the issue by adding a "thumbs-up reaction". We use this to help prioritize issues!
- If none of that is helping, create an issue with the following information:
- Clear title (shorter is better).
- Describe the issue in clear language.
- Share error logs, screenshots and etc.
- To speed up the issue fixing process, send us a sample repo with the issue you faced.
1. Search the [issue list](https://github.com/clbrge/svelte-web3/issues) for current and old issues.
- If you find an existing issue, please UPVOTE the issue by adding a "thumbs-up reaction". We use this to help prioritize issues!
2. If none of that is helping, create an issue with the following information:
- Clear title (shorter is better).
- Describe the issue in clear language.
- Share error logs, screenshots, etc.
- To speed up the issue fixing process, send us a sample repo with the issue you faced.

## Pull Requests (PRs)

We welcome all contributions.
We welcome all contributions. Before submitting a pull request, please ensure you have followed these guidelines:

1. Make sure your code follows the [Standard JavaScript style](https://standardjs.com/).
2. Provide a clear and concise description of the changes in the PR title and description.
3. Ensure that your changes do not introduce new linting or test errors.
4. Update any relevant documentation or tests as necessary.

0 comments on commit baa90e0

Please sign in to comment.