Skip to content

Commit

Permalink
doc: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
arnaud-ritti committed Mar 15, 2024
1 parent a550332 commit 6fd1f2b
Show file tree
Hide file tree
Showing 10 changed files with 261 additions and 31 deletions.
44 changes: 44 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@

# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4.
72 changes: 72 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
name: Bug report
description: Create a bug report to help us fix a demonstrable problem with code in the package.
title: "[BUG]: <Context of the issue>"
labels: [bug]
assignees: jeromeengeln
body:
- type: textarea
id: description
attributes:
label: Issue description
description: |
Describe the issue in as much detail as possible.
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files into it.
placeholder: |
Steps to reproduce with below code sample:
1. do thing
2. click...
3. observe behavior
4. see error logs below
validations:
required: true
- type: textarea
id: media
attributes:
label: Media & Screenshots
description: Include screenshots or video of reproduction as much as possible
- type: input
id: theme-version
attributes:
label: SyliusTailwindcssTheme Version
description: What version of SyliusTailwindcssTheme are you using?
placeholder: 0.0.1
validations:
required: false
- type: textarea
id: versions
attributes:
label: Versions
description: Which versions are you using?
value: |
- Sylius version: [1.12]
- Symfony version: [6.4, 7.0]
- PHP version: [7.4, 8.0, 8.1, 8.2, 8.3]
- Any other details...
- type: textarea
id: browser
attributes:
label: Web Browser
description: Which web browser are you using?
value: |
- Browser [e.g. chrome, safari]:
- Any other details...
- type: dropdown
id: priority
attributes:
label: Priority this issue should have
description: Please be realistic. If you need to elaborate on your reasoning, please use the Issue description field above.
options:
- Low (slightly annoying)
- Medium (should be fixed soon)
- High (immediate attention needed)
validations:
required: true
- type: checkboxes
id: questions
attributes:
label: Please review the checkboxes that are applicable.
options:
- label: This issue is directly related to Sylius
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
contact_links:
- name: Help & Support
url: https://github.com/agence-adeliom/sylius-tailwindcss-theme/discussions/categories/q-a
about: Please don't create issues for personal help requests. Instead, ask your question on the discussion forum.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Feature request
description: Suggest a new feature or enhancement for the package
title: "[Feature Request]: <Context of the feature request>"
labels: [feature]
assignees: jeromeengeln
body:
- type: textarea
id: problem-description
attributes:
label: Describe the problem or use case
description: |
Provide a detailed description of the problem or use case that the proposed feature aims to address.
For example: "When using the AWC in scenario X, I encountered issues with..."
validations:
required: true
- type: textarea
id: solution-description
attributes:
label: Proposed solution
description: |
Describe your proposed solution or enhancement in detail.
Explain how the new feature would work and how it would address the problem or improve the AWC.
- type: textarea
id: alternatives-description
attributes:
label: Alternatives considered
description: |
If you have considered any alternative approaches or solutions, please describe them here.
Explain why the proposed solution is preferred over the alternatives.
- type: textarea
id: additional-context
attributes:
label: Additional technical context
description: |
Provide any additional technical context or considerations that may be relevant to the feature request.
Include code snippets, relevant documentation, or any other information that can help the development team understand and evaluate the request better.
15 changes: 0 additions & 15 deletions .github/PULL_REQUEST_TEMPLATE.md

This file was deleted.

8 changes: 8 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<Provide a detailed explanation of the changes, why they were necessary, and their benefits or impact>
<Explain the problem you are fixing or the feature you are adding>

## Checklist
- [ ] I have read the [contributing guide](../CONTRIBUTNIG.md)
- [ ] I have updated the documentation (if necessary)

<Specify the issues this PR closes, by using closing words like `Closing #[number]`, `Fixes #[number]`>
7 changes: 7 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Reporting Security Issues

We take security issues in the theme package very seriously and appreciate your efforts to disclose your findings responsibly.

To report a security issue, email [[email protected]](mailto:[email protected]) and include "Sylius Tailwind Theme" in the subject line.

We'll respond as soon as possible and keep you updated throughout the process.
45 changes: 45 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
version: 2
updates:
- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "weekly"
target-branch: "0.x"
allow:
- dependency-type: "direct"
labels:
- "npm"
- "dependencies"
commit-message:
prefix: "fix"
prefix-development: "build"
include: "scope"

- package-ecosystem: "composer"
directory: "/"
schedule:
interval: "weekly"
target-branch: "0.x"
allow:
- dependency-type: "direct"
labels:
- "composer"
- "dependencies"
commit-message:
prefix: "fix"
prefix-development: "build"
include: "scope"

- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
target-branch: "0.x"
allow:
- dependency-type: "direct"
labels:
- "github-actions"
- "dependencies"
commit-message:
prefix: "ci"
include: "scope"
55 changes: 40 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,55 @@
<img src="./docs/medias/sylius.svg" alt="image" width="300" height="auto">

# SyliusTailwindcssTheme
A Sylius theme powered by Tailwindcss, DaisyUI, SyliusThemeBundle, WebpackEncoreBundle.
By [Adeliom](https://www.adeliom.com)
<p align="center">
<img width="40%" src="./docs/medias/sylius.svg" />
<h1 align="center">SyliusTailwindcssTheme</h1>
<p align="center">A Sylius theme powered by Tailwindcss, DaisyUI with build process based on <a target="_blank" href="https://symfony.com/doc/current/frontend.html">Webpack Encore.</a>
<br/>By <a target="_blank" href="https://www.adeliom.com">Adeliom</a></p>
</p>
<p align="center">
<img alt="Packagist Downloads" src="https://img.shields.io/packagist/dm/agence-adeliom/sylius-tailwindcss-theme" />
</p>

### Try our demo 🚀 [https://sylius-tailwind.adeliom.io/](https://sylius-tailwind.adeliom.io/)

## Preview

### Homepage

<a href="./docs/medias/home1.png" target="_blank">
<img src="./docs/medias/home1.png" align="center" height="50%">
</a>

### [View more](./docs/screenshots.md)

### Performance tests

<details>
<summary>Desktop</summary>
<hr>
<a href="./docs/medias/notes_desktop.png" target="_blank">
<img src="./docs/medias/notes_desktop.png" align="center">
</a>
</details>

<details>
<summary>Mobile</summary>
<hr>
<a href="./docs/medias/notes_mobile.png" target="_blank">
<img src="./docs/medias/notes_mobile.png" align="center">
</a>
</details>

## Why Tailwindcss & DaisyUI

TODO

## Discover

| Discover | |
|:---------------------|--------------------------------------------------------------------------:|
| Demo | [Visit our demo site](https://www.adeliom.com) 🚀 |
| Screenshots | ![notes!](./docs/medias/home1.png)<br/>[View more](./docs/screenshots.md) |
| Performances desktop | ![notes!](./docs/medias/notes_desktop.png) |
| Performances mobile | ![notes!](./docs/medias/notes_mobile.png) |

## Documentation

[Documentation is available in the *docs* folder.](docs/index.md)


## Bug Tracking

If you want to report a bug or suggest an idea, please use [GitHub issues](https://github.com/royalphp/sylius-bootstrap-theme/issues).
If you want to report a bug or suggest an idea, please use [GitHub issues](https://github.com/agence-adeliom/sylius-tailwindcss-theme/issues).

## License

Expand Down
2 changes: 1 addition & 1 deletion docs/contribution.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Installation for contribution & test

### Prerequis
### Requirement

- Install [DDEV](https://ddev.readthedocs.io/en/stable/)

Expand Down

0 comments on commit 6fd1f2b

Please sign in to comment.