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 improve the project you can always start a conversation through the discussions page. Please, make sure you are respectful towards all members of the community. We take our open-source community seriously and hold ourselves and our contributors to high communication standards. If an issue is spotted, you can use the issues page.
Contributions are made to this repository via Issues and Pull Requests (PRs). A few general guidelines that cover both:
- Search for existing related Issues and PRs before creating your own.
- Make sure you are clear about your ideas and expose as much information as you possibly can, as that can help the investigation process immensly. (e.g. code samples, images).
- We work hard to handle and respond to all Issues as soon as possible, but it can take time to investigate root causes. Please be patient.
If you don't know where to start, you can take a look at the Getting Started section on our wiki.
The issues page is open to discuss any subject that is related to the project, such as code changes, feature requestes, potential enhancements, etc...
If you find any topic related to your subject, please feel free to post your story and provide any information you think might help.
All PRs are welcome. PRs are the fastest way to solve your issue. We are going to review all of them as fast as possible.
You can create branches from the develop branch and name them in accordance with conventional
commits here, or follow the examples below:
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 nor adds a feature
style: markup, white space, formatting, missing semi-colons...Please ensure your code is clear and readable and provide as much information as you can in the description.
⚠️ Your code and any changes made need to be covered with tests
⚠️ In case of need, you have to provide all documentation changes within your PR
This is a mono repo so testing will be dependent on the specific folder you are in. Please refer to the readme, test folder, and package.json commands for the testing specifics in the directory you are working in. Reegarding contract, this project has test suites both in Solidity and JavaScript. We use Hardhat and Foundry frameworks. It is mandatory for all tests to be well described to make the code consistent and secure. To get more information about this topic, check the Testing section on our wiki. You can also treat existing test suites as your inspiration. They are located at the test folder.
Join us at our Discord Server. Let's build a great community together!