Skip to content

Commit

Permalink
Merge branch 'stable' of https://github.com/hm21/pro_image_editor int…
Browse files Browse the repository at this point in the history
…o dev
  • Loading branch information
hm21 committed Jan 24, 2025
2 parents 8d0bd1a + c2b0904 commit 0782a0c
Show file tree
Hide file tree
Showing 5 changed files with 326 additions and 5 deletions.
17 changes: 12 additions & 5 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,23 @@
name: Question
description: Please use the discuss tab to ask a question.
description: If you have a question, please use the Discussions tab instead.
title: "[Question] "
labels: ["question"]
body:
- type: markdown
attributes:
value: |
Please use the [discuss](https://github.com/hm21/pro_image_editor/discussions) tab to ask a question.
## Please use the [Discussions](https://github.com/hm21/pro_image_editor/discussions) tab for questions!
The **Issues** tab is for reporting bugs or suggesting features. For general questions, support, or guidance, the **Discussions** tab is the right place to go. This helps us keep the issues section focused and organized.
If your question is about how to use a feature or best practices, feel free to search the Discussions tab first, as your question may have already been answered!
Thank you for your understanding and cooperation.
- type: input
id: placeholder
attributes:
label: Please use the discuss tab to ask a question.
description: "Please use the discuss tab to ask a question."
label: PLEASE USE THE DISCUSS TAB TO ASK A QUESTION!
placeholder: PLEASE USE THE DISCUSS TAB TO ASK A QUESTION!
description: "PLEASE USE THE DISCUSS TAB TO ASK A QUESTION!"
validations:
required: false
required: true
42 changes: 42 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
## PR Checklist
Please check if your PR fulfills the following requirements:

- [ ] The commit message follows our guidelines: https://github.com/hm21/pro_image_editor/blob/stable/CONTRIBUTING.md#style-guides
- [ ] Tests for the changes have been added (for bug fixes / features)
- [ ] Docs have been added / updated (for bug fixes / features)


## PR Type
What kind of change does this PR introduce?

<!-- Please check the one that applies to this PR using "x". -->

- [ ] Bugfix
- [ ] Feature
- [ ] Code style update (formatting, local variables)
- [ ] Refactoring (no functional changes, no api changes)
- [ ] Build related changes
- [ ] CI related changes
- [ ] Documentation content changes
- [ ] Other... Please describe:


## What is the current behavior?
<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->

Issue Number: N/A


## What is the new behavior?


## Does this PR introduce a breaking change?

- [ ] Yes
- [ ] No


<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->


## Other information
128 changes: 128 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible 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.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

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

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders 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, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
107 changes: 107 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
# Contributing to ProImageEditor

First off, thank you for considering contributing to ProImageEditor! Your support helps make this project better for everyone.

## Table of Contents

- [Code of Conduct](#code-of-conduct)
- [How Can I Contribute?](#how-can-i-contribute)
- [Reporting Bugs](#reporting-bugs)
- [Suggesting Enhancements](#suggesting-enhancements)
- [Submitting Pull Requests](#submitting-pull-requests)
- [Development Setup](#development-setup)
- [Style Guides](#style-guides)
- [Git Commit Messages](#git-commit-messages)
- [Dart Code Style](#dart-code-style)
- [Additional Resources](#additional-resources)

## Code of Conduct

Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.

## How Can I Contribute?

### Reporting Bugs

If you encounter a bug, please report it by [opening a bug report](https://github.com/hm21/pro_image_editor/issues/new?template=bug_report.yml). The bug report template will guide you to provide the necessary details, such as:

- Steps to reproduce the issue.
- Expected and actual behavior.
- Screenshots or code snippets.
- Environment details (e.g., OS, Flutter version, etc.).

### Suggesting Enhancements

We welcome suggestions to improve ProImageEditor! To propose an enhancement, [open a feature request](https://github.com/hm21/pro_image_editor/issues/new?template=feature_request.yml). The feature request template includes fields for:

- A description of the proposed enhancement.
- The problem it solves or the benefit it provides.
- Any relevant examples, mockups, or use cases.

### Submitting Pull Requests

To contribute code:

1. Fork the repository.
2. Create a new branch (`git checkout -b feature/YourFeatureName`).
3. Make your changes, ensuring they adhere to the project's coding standards.
4. Run `dart analyze` to ensure no static analysis issues.
5. Run `flutter test` to ensure all tests pass.
6. Commit your changes with a [conventional git commit](https://www.conventionalcommits.org/en/v1.0.0/).
7. Push to your forked repository (`git push origin feature/YourFeatureName`).
8. [Open a pull request](https://github.com/hm21/pro_image_editor/compare) against the `stable` branch.


In your pull request:

- Reference any related issues.
- Provide a clear description of the changes and their purpose.
- Highlight any areas that may need special attention during review.

## Development Setup

To set up a local development environment:

1. Ensure you have [Flutter](https://flutter.dev/docs/get-started/install) installed.
2. Clone the repository: `git clone https://github.com/hm21/pro_image_editor.git`
3. Navigate to the project directory: `cd pro_image_editor`
4. Install dependencies: `flutter pub get`
5. Run the example app to test: `flutter run`

## Style Guides

### Git Commit Messages

We use **conventional commits** for commit messages. Please follow this format: `<type>(scope): <subject>`

Examples:

- `feat(editor): add new filter options`
- `fix(image_processing): resolve crash on iOS devices`
- `docs(contributing): update contributing guidelines`

Valid commit types include:

- `feat`: A new feature.
- `fix`: A bug fix.
- `docs`: Documentation changes.
- `style`: Code style changes (white-space, formatting, etc.).
- `refactor`: Code refactoring without changing functionality.
- `test`: Adding or updating tests.
- `chore`: Maintenance tasks (e.g., updating dependencies).

### Dart Code Standards

- Follow the [Dart style guide](https://dart.dev/guides/language/effective-dart/style).
- Use `flutter format` to format your code.
- Ensure that **`dart analyze`** runs without any warnings or errors.
- Ensure that **`flutter test`** passes without failures.
- Write documentation comments for public APIs.

## Additional Resources

- [Flutter Documentation](https://flutter.dev/docs)
- [Dart Documentation](https://dart.dev/guides)
- [Effective Dart](https://dart.dev/effective-dart)

Thank you for contributing to ProImageEditor!
37 changes: 37 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Security Policy

## Supported Versions

We actively support and release security updates for the following versions of `pro_image_editor`:

| Version | Supported |
|-----------------|--------------------|
| Latest release ||
| Older versions ||

Please update to the latest version to ensure you receive the latest security patches and updates.

## Reporting a Vulnerability

If you discover a security vulnerability in `pro_image_editor`, please report it responsibly to help us maintain a safe and secure project.

### Steps to Report:
1. **Do not open a public issue.**
Instead, email us privately at **[[email protected]]** to report the issue.

2. **Include the following details in your report:**
- A detailed description of the vulnerability.
- Steps to reproduce the issue.
- The potential impact of the vulnerability.
- Any suggested fixes or mitigations.

3. **Response Time:**
We aim to acknowledge security reports within **48 hours** and provide a resolution or mitigation plan within **7 days**, depending on the severity and complexity of the issue.

4. **Confidentiality:**
We request you keep the vulnerability confidential until we have released a fix and informed our users.

## Thank You

We appreciate your efforts to responsibly disclose security issues. Your contribution helps make `pro_image_editor` safer for everyone.

0 comments on commit 0782a0c

Please sign in to comment.