Skip to content

Commit

Permalink
change contributing guide (#72)
Browse files Browse the repository at this point in the history
  • Loading branch information
willpinha authored Jan 22, 2024
1 parent 45d3eba commit 34b50b7
Showing 1 changed file with 37 additions and 16 deletions.
53 changes: 37 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,37 @@
# Contributing to the Daisy Collection

Thank you for considering contributing to our open source project. Whether you are fixing a
bug, implementing a new feature or improving code, your efforts make a difference. Together,
We can create an amazing collection of UI examples for DaisyUI that everyone can use!
Thank you for considering contributing to our open source project. Whether you are fixing a problem
or making an improvement, your efforts make a difference. Together, we can create an amazing
collection of UI examples for DaisyUI that everyone can use!

The main way to contribute is by adding new user interface (UI) examples such as navigation bars, sidebars, authentication forms, blog sections, and so on. Other ways to contribute include reporting
issues and make feature requests
Currently, there are 4 ways to contribute:

## Guide to add a new UI example
- [Add new UI examples]() such as navigation bars, sidebars, authentication forms, blog sections,
and so on
- [Report problems with UI examples]()
- [Point out improvements to UI examples]()
- [Share with others]()

### 1. Fork the repository
## Project structure

All UI examples are located in the `src/examples` folder. Each subfolder within it is a tag and
each file within these tags is a UI example

A UI example is simply an HTML file containing DaisyUI, TailwindCSS and Font Awesome classes

## Contributing

### Add a new UI example

#### 1. Fork the repository

The first step is to fork this repository

### 2. Build the project
#### 2. Create a new branch

Create a new branch on the fork, where you can work on your contribution

#### 3. Build the project

This project is made with [Astro](https://astro.build/) and [Svelte](https://svelte.dev/). After
forking the repository, clone your fork locally and install all dependencies:
Expand All @@ -28,9 +46,10 @@ After that, start the Astro web server:
npm run dev
```

### 3. Make a new UI example
#### 4. Make a new UI example

In the `src/examples` folder, there are many subfolders such as `navbar` and `sidebar`. Each of these subfolders is a tag that groups UI examples
In the `src/examples` folder, there are many subfolders such as `navbar` and `sidebar`. Each of these
subfolders is a tag that groups UI examples

To add a new UI example, simply create an HTML file within one of these tag subfolders

Expand All @@ -46,7 +65,7 @@ HTML comments in code to separate and organize it better
> [!IMPORTANT]
> To make things more organized, add only one UI example per pull request
### 4. Make a pull request
#### 5. Make a pull request

After you finish your UI example, submit a pull request. Make sure your UI example:

Expand All @@ -60,17 +79,19 @@ That's it. If you followed all the steps, your UI example will be added to the c
> Please be aware that there are no guarantees that your pull request will be accepted. If it is not
> accepted, a comment will be left explaining why
## Other ways to contribute
> [!IMPORTANT]
> Please allow changes to the pull request code for possible improvements before the pull request is
> merged
### [Report problems](https://github.com/willpinha/daisy-collection/issues/new?assignees=willpinha&labels=bug&projects=&template=report_problem.yml)
### Report problems with UI examples

If you find any bugs in the collection or ways to improve the existing code, please submit an issue
explaining the problem. If it's simple to solve, you can submit a pull request referencing your issue

### [Make feature requests](https://github.com/willpinha/daisy-collection/issues/new?assignees=willpinha&labels=enhancement&projects=&template=feature_request.yml)
### Point out improvements to UI examples

If you would like to see any new features in this collection, please submit an issue explaining which
feature you want. If it's simple to implement, you can submit a pull request referencing your issue
If you see something in the look or code of a sample UI that could be improved, please submit an issue
explaining the improvement

### Share with others

Expand Down

0 comments on commit 34b50b7

Please sign in to comment.