Skip to content

Latest commit

 

History

History
82 lines (50 loc) · 4.48 KB

CONTRIBUTING.md

File metadata and controls

82 lines (50 loc) · 4.48 KB

Contributing to flowbite-react

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

Table of Contents

Code of Conduct

This project has adopted the Contributor Covenant as its Code of Conduct. Everyone is expected to adhere to these rules, so please read the full text. Thank you.

I Have a Question

If you want to ask a question, we assume that you have basic understanding of Solidity and Etheruem Documentation (https://ethereum.org/en/developers/docs/).

You can reach us out on Discord (https://discord.gg/CADQKy39), We will then take care of the issue as soon as possible.

I Want To Contribute

  • You can create an issue if you want to create a demo for new ERC/EIPs
  • You can create an issue if you see any improvement in pre-existing code
  • You can reach us on Discord if you want to have a discussion

Legal Notice

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the [project license].

Suggesting New Example of ERC/EIP

This section guides you through submitting an code example of ERC/EIPs for Chapter-Solidity, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

Before Submitting an Example of ERC/EIP

  • Make sure that example is not already being covered in the project.
  • You have gathered enough resources to work on that.
  • If Someone else has already proposed the same example and still working on that then reach him/her out and ask if any help needed.
  • Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. See from a bigger picture and represents the use case as well.

How Do I Submit the code

Enhancement suggestions are tracked as GitHub issues.

  • Use a clear and descriptive title for the issue to identify the suggestion.

Don't forget to:

  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • It is compulsory to provide a working demo of your code. Make a recording of 10mb and then upload it on the Readme of your folder. If your recording is above 10mb then compress it to 10mb.
  • Write the article of your code, where explain the code with the steps of execution. Write down the use case more in detail. Article should be published and publically available. Dont forget to mention the link into README of your folder.

Your First Code Contribution

Prerequisites

  • You need to understand how to Solidity, Ethereum and RemixIDE

Creating a Pull Request

  1. Fork the repository
  2. Clone the fork and add a remote called upstream:
  3. Work on your propose issue, test it, record the demo
  4. Create the PR

What Happens Next?

If you have followed the steps above, your Pull Request will be reviewed by a maintainer soon. If it passes review, it will be merged into the main branch. If not, you will receive feedback about what needs to be improved until it is ready to be merged.

Styleguides