👍🎉First of all, thank you for taking the time to contribute!🎉👍
The following is a set of guidelines for contributing to the Developer Portal, which are hosted in the Cardano Foundation on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
@TODO link
Please check out our Discussions section. Maybe you find a thread that answers your questions. If not, feel free to open a new thread and explain what you are wondering about.
Discussions are also the place to talk about your ideas on how to improve the portal and engage with the developers.
Make yourself familiar with the Project Structure.
We try to keep everything as simple as possible, but not simpler. If you see something that could be improved, you are encouraged to raise an issue wherein you propose your changes and explain the rationale.
The project showcase should be a place where someone new to the ecosystem can come to see what can be done - it should not be seen as a database where every project is promoted.
Read the requirements and follow the instructions in the header of the src/data/showcases.js file
Descriptions help users find a project they are interested in and decide whether to visit the links you provided. Use relevant keywords and describe what your project is all about or what it does. Don't include claims in your description like the best wallet, the first ABC or the only XYZ. We will ask you to change the description in your pull request before merging. @TODO rationale?
This section features tools that help developers build on Cardano.
Read the requirements and follow the instructions in the header of the src/data/builder-tools.js file.
To maintain the quality of content on the developer portal, we use pull requests to integrate changes from contributors.
Please follow these steps to have your contribution considered by the maintainers:
- Follow all instructions in the template
- Follow the styleguides
- After you submit your pull request, verify that all status checks are passing
What if the status checks are failing?
If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track and resolve that problem.
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.