mirror of
https://github.com/matter-labs/ansible-en-role.git
synced 2025-12-06 10:59:56 +00:00
45 lines
2.0 KiB
Markdown
45 lines
2.0 KiB
Markdown
# Contribution Guidelines
|
|
|
|
Hello! Thanks for your interest in joining the mission to accelerate the mass adoption of crypto for personal
|
|
sovereignty! We welcome contributions from anyone on the internet, and are grateful for even the smallest of fixes!
|
|
|
|
## Ways to contribute
|
|
|
|
There are many ways to contribute to the external node role:
|
|
|
|
1. Open issues: if you find a bug, have something you believe needs to be fixed, or have an idea for a feature, please
|
|
open an issue.
|
|
2. Add color to existing issues: provide screenshots, code snippets, and whatever you think would be helpful to resolve
|
|
issues.
|
|
3. Resolve issues: either by showing an issue isn't a problem and the current state is ok as is or by fixing the problem
|
|
and opening a PR.
|
|
4. Report security issues, see [our security policy](./SECURITY.md).
|
|
5. [Join the team!](https://matterlabs.notion.site/Shape-the-future-of-Ethereum-at-Matter-Labs-dfb3b5a037044bb3a8006af2eb0575e0)
|
|
|
|
## Fixing issues
|
|
|
|
To contribute code fixing issues, please fork the repo, fix an issue, commit, add documentation as per the PR template,
|
|
and the repo's maintainers will review the PR.
|
|
[here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)
|
|
for guidance how to work with PRs created from a fork.
|
|
|
|
## Licenses
|
|
|
|
If you contribute to this project, your contributions will be made to the project under both Apache 2.0 and the MIT
|
|
license.
|
|
|
|
## Code of Conduct
|
|
|
|
Be polite and respectful.
|
|
|
|
## FAQ
|
|
|
|
**Q**: I have a small contribution that's not getting traction/being merged?
|
|
|
|
**A**: Due to capacity, contributions that are simple renames of variables or stylistic/minor text improvements, one-off
|
|
typo fix will not be merged. If you do find any typos or grammar errors, the preferred avenue is to improve the existing
|
|
spellchecker. Given you have no technical prowess to do so, please create an issue. Please note that issues will be
|
|
resolved on a best effort basis.
|
|
|
|
### Thank you
|