3.0 KiB
Contributing
The core developer team of Fleek Non Fungible Apps welcomes all contributions from the community to achieve consistent code updates and enhancements.
If you want to help us to improve the project you can always start a conversation through the issues page. By doing it make sure you are being ethical and respectful with anyone on the community. We take our open source community seriously and hold ourselves and other contributors to high standards of communication.
Getting Started
Contributions are made to this repo via Issues and Pull Requests (PRs). A few general guidelines that cover both:
- Search for existing Issues and PRs related before creating your own;
- Make sure you are being clear about your ideas and expose as much information as you can (e.g. code samples, images);
- We will be working hard to handle and respond all Issues as soon as possible, but it can takes time for investigation root causes. Please be patient.
If you don't know where to start, you can take a look in the Getting Started section on our wiki.
Issues
The issues page is open to discuss about any subject that is tangible to the project, it can be any problem report, feature request, potential changes, etc.
If you find any topics related to your subject, please feel free to post your story and provide any kind of information you think it might help.
Pull Requests
All PRs are welcome and it will be the fastest way to solve your issue. We are going to kindly review all of them as fast as possible.
You are able to create branches from the main branch and name it in accordance to conventional
commits here, or follow the examples bellow:
test: adding missing tests
feat: a new feature
fix: a bug fix
chore: build process or auxiliary tool changes
docs: documentation only changes
refactor: code change that neither fixes a bug or adds a feature
style: markup, white-space, formatting, missing semi-colons...
Please ensure your code is clear and readable and also provide as much information you can in the description.
⚠️ Your code and any changes made needs to be covered with tests
⚠️ In case of need, you have to provide all documentation changes within your PR
Testing
We are up to write tests using both Hardhat and Foundry frameworks. Its mandatory that all tests were well described and all validations to make the code consistent and secure. To get more information about it, check the Testing section on our wiki. You can also get some examples of how to test it on test folder.
Getting help
Join us on our Discord Server. Let's build a great community together!