-
-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add contributing doc and update readme
- Loading branch information
Showing
2 changed files
with
44 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Contributing to Delegation Framework | ||
|
||
Thank you for your interest in contributing to the Delegation Framework! Your contributions help make this project better for everyone. Below are guidelines to help you get started. | ||
|
||
## Code of Conduct | ||
|
||
This project and everyone participating in it are governed by the [MetaMask Code of Conduct](https://github.com/MetaMask/delegation-framework?tab=coc-ov-file). By participating, you are expected to uphold this code. | ||
|
||
## How Can I Contribute? | ||
|
||
You can [open an issue](https://github.com/MetaMask/delegation-framework/issues/new/choose) to suggest a feature. Please follow the new feature template. To report a bug, please follow our [security policy](https://github.com/MetaMask/delegation-framework/security/policy). | ||
|
||
Before creating a new issue, check the current open and closed issues to see if your concern has already been addressed. Adding a comment to an existing issue can often be more effective. | ||
|
||
When suggesting a new feature, provide comprehensive details, particularly about the motivating use cases. Clearly illustrating the feature’s potential impact on the ecosystem can help prioritize its development. High-impact features are given priority, so detailed explanations are highly valued. | ||
|
||
### Submitting Pull Requests | ||
|
||
All Pull Requests must be paired with an open issue. When creating a Pull Request, you will be presented with a PR template; please be as detailed and thorough as possible to increase the likelihood of your PR being merged. | ||
|
||
Create your PR against `main` as the base branch. | ||
|
||
Please ensure your pull request adheres to the [style guide](https://github.com/MetaMask/delegation-framework/blob/main/documents/StyleGuide.md) and includes unit tests for new functionality. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters