Skip to content

Commit 023c92e

Browse files
aspicasaspicas
authored
Merge pull request #4 from aspicas/feature/add-contributing-file
Feature/add contributing file
2 parents 40e650d + 83515d3 commit 023c92e

File tree

7 files changed

+297
-2
lines changed

7 files changed

+297
-2
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: "Bug report"
3+
description: "Report a reproducible bug or regression."
4+
labels: [bug]
5+
---
6+
7+
## Describe the bug
8+
9+
A clear and concise description of what the bug is.
10+
11+
## To Reproduce
12+
13+
Steps to reproduce the behavior:
14+
15+
1. Go to '...'
16+
2. Run '...'
17+
3. See error
18+
19+
## Expected behavior
20+
21+
A clear and concise description of what you expected to happen.
22+
23+
## Actual behavior
24+
25+
What actually happened instead?
26+
27+
## Environment (please complete the following information):
28+
29+
- OS: [e.g. iOS, Android]
30+
- Dart/Flutter version: [e.g. 3.0.0, 2.10.0]
31+
- Library version: [e.g. 1.2.3]
32+
33+
## Additional context
34+
35+
Add any other context about the problem here. Include logs, error messages, or screenshots if possible.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: "Feature request"
3+
description: "Suggest an idea or enhancement for this project."
4+
labels: [enhancement]
5+
---
6+
7+
## Is your feature request related to a problem? Please describe.
8+
9+
A clear and concise description of what the problem is. Ex: I'm always frustrated when [...]
10+
11+
## Describe the solution you'd like
12+
13+
A clear and concise description of what you want to happen.
14+
15+
## Describe alternatives you've considered
16+
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
## Additional context
20+
21+
Add any other context or screenshots about the feature request here.

‎.github/pull_request_template.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Pull Request
2+
3+
## Description
4+
5+
Please include a summary of the change and which issue is fixed. Also include relevant motivation and context.
6+
7+
Fixes # (issue)
8+
9+
## Type of change
10+
11+
- [ ] Bug fix
12+
- [ ] New feature
13+
- [ ] Breaking change
14+
- [ ] Documentation update
15+
- [ ] Other (please describe):
16+
17+
## How Has This Been Tested?
18+
19+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
20+
21+
## Checklist
22+
23+
- [ ] My code follows the style guidelines of this project
24+
- [ ] I have performed a self-review of my own code
25+
- [ ] I have commented my code, particularly in hard-to-understand areas
26+
- [ ] I have made corresponding changes to the documentation
27+
- [ ] My changes generate no new warnings
28+
- [ ] I have added tests that prove my fix is effective or that my feature works
29+
- [ ] New and existing unit tests pass locally with my changes
30+
- [ ] Any dependent changes have been merged and published in downstream modules
31+
32+
## Additional context
33+
34+
Add any other context or screenshots about the pull request here.

‎CODE_OF_CONDUCT.md‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
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.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
- Demonstrating empathy and kindness toward other people
14+
- Being respectful of differing opinions, viewpoints, and experiences
15+
- Giving and gracefully accepting constructive feedback
16+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
- Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
- Trolling, insulting or derogatory comments, and personal or political attacks
23+
- Public or private harassment
24+
- Publishing others' private information, such as a physical or email address, without their explicit permission
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
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.
30+
31+
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.
32+
33+
## Scope
34+
35+
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.
36+
37+
## Enforcement
38+
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at davidgarcia93.github@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
40+
41+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
42+
43+
## Enforcement Guidelines
44+
45+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46+
47+
### 1. Correction
48+
49+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
50+
51+
**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.
52+
53+
### 2. Warning
54+
55+
**Community Impact**: A violation through a single incident or series of actions.
56+
57+
**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.
58+
59+
### 3. Temporary Ban
60+
61+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
62+
63+
**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.
64+
65+
### 4. Permanent Ban
66+
67+
**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.
68+
69+
**Consequence**: A permanent ban from any sort of public interaction within the community.
70+
71+
## Attribution
72+
73+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
74+
75+
For answers to common questions about this code of conduct, see [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq).

‎CONTRIBUTING.md‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Contributing to flutter_policy_engine
2+
3+
Thank you for your interest in contributing! We welcome contributions from everyone. If you are not a direct collaborator, please follow the **fork-and-pull-request** workflow described below.
4+
5+
## Branch Strategy
6+
7+
- **develop**: All external pull requests must target the `develop` branch. This is where active development happens.
8+
- **main**: The `main` branch is reserved for stable releases. It is updated internally by the maintainers via a pull request from `develop` to `main`.
9+
- **Do not submit pull requests directly to `main`.**
10+
11+
## 1. Prerequisites
12+
13+
- Ensure you have a [GitHub account](https://github.com/).
14+
- Install [Git](https://git-scm.com/) and [Flutter](https://flutter.dev/docs/get-started/install) on your machine.
15+
- Familiarize yourself with our [README.md](./README.md) and project structure.
16+
17+
## 2. Forking the Repository
18+
19+
- Navigate to the [flutter_policy_engine GitHub page](https://github.com/your-org/flutter_policy_engine).
20+
- Click the **Fork** button (top right) to create your own copy of the repository.
21+
22+
## 3. Cloning Your Fork
23+
24+
- Clone your fork to your local machine:
25+
```sh
26+
git clone https://github.com/your-username/flutter_policy_engine.git
27+
cd flutter_policy_engine
28+
```
29+
30+
## 4. Creating a Feature Branch
31+
32+
- Always create a new branch for your work:
33+
```sh
34+
git checkout -b feature/your-feature-name
35+
```
36+
- Use descriptive branch names (e.g., `feature/add-logging`, `fix/null-pointer-issue`).
37+
38+
## 5. Making Changes
39+
40+
- Make your changes in the appropriate files.
41+
- Follow the language and framework conventions (Dart/Flutter best practices).
42+
- Write clear, self-documenting code. Add docstrings for public APIs and explain the "why" in comments if needed.
43+
- Add or update tests for your changes.
44+
45+
## 6. Keeping Your Fork Up to Date
46+
47+
- Sync your fork with the upstream repository to avoid merge conflicts:
48+
```sh
49+
git remote add upstream https://github.com/your-org/flutter_policy_engine.git
50+
git fetch upstream
51+
git merge upstream/develop
52+
```
53+
54+
## 7. Commit Messages
55+
56+
- Write concise, meaningful commit messages.
57+
- Use the present tense (e.g., "Add feature X", "Fix bug Y").
58+
- Group related changes into a single commit when possible.
59+
60+
## 8. Submitting a Pull Request
61+
62+
- Push your branch to your fork:
63+
```sh
64+
git push origin feature/your-feature-name
65+
```
66+
- Go to your fork on GitHub and click **Compare & pull request**.
67+
- **Set the base branch to `develop` in the main repository.**
68+
- Fill out the PR template, describing your changes and referencing any related issues.
69+
- Submit the pull request to the `develop` branch.
70+
71+
## 9. Code Review Process
72+
73+
- Your PR will be reviewed by maintainers.
74+
- Be responsive to feedback and make requested changes.
75+
- Once approved, your PR will be merged into `develop`.
76+
- The `main` branch is updated internally by maintainers via a separate pull request from `develop` to `main`.
77+
78+
## 10. Additional Guidelines
79+
80+
- Ensure all tests pass before submitting your PR.
81+
- Follow our code style and linting rules (see `analysis_options.yaml`).
82+
- Do not include unrelated changes in your PR.
83+
- If your change is significant, consider updating the documentation.
84+
85+
## 11. Contact
86+
87+
If you have questions, open an issue or contact the maintainers via GitHub Discussions or Issues.
88+
89+
---
90+
91+
Thank you for helping make this project better!

‎SECURITY.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
If you discover a security vulnerability in this project, please report it privately. Do **not** create a public issue. Instead, email the maintainers at:
6+
7+
**davidgarcia93.github@gmail.com**
8+
9+
Please include as much detail as possible to help us understand and address the issue quickly:
10+
11+
- Description of the vulnerability
12+
- Steps to reproduce (if applicable)
13+
- Potential impact
14+
- Any suggested mitigation or patch
15+
16+
We will acknowledge receipt of your report as soon as possible and work to provide a status update or resolution in a timely manner.
17+
18+
## Responsible Disclosure
19+
20+
We ask that you:
21+
22+
- Give us a reasonable amount of time to address the issue before disclosing it publicly.
23+
- Do not exploit the vulnerability or share it with others before it is resolved.
24+
- Act in good faith to avoid privacy violations, data destruction, or service disruption.
25+
26+
Thank you for helping keep this project and its users safe!

‎pubspec.yaml‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,23 @@
11
name: flutter_policy_engine
22
description: "A new Flutter package project."
33
version: 0.0.1
4-
homepage:
4+
# homepage: https://github.com/davidgarcia93/flutter_policy_engine
5+
repository: https://github.com/davidgarcia93/flutter_policy_engine
6+
issue_tracker: https://github.com/davidgarcia93/flutter_policy_engine/issues
7+
documentation: https://github.com/davidgarcia93/flutter_policy_engine#readme
8+
topics:
9+
- flutter
10+
- policy
11+
- engine
12+
- authorization
13+
publish_to: "https://pub.dev"
14+
# funding:
15+
# - https://github.com/sponsors/davidgarcia93
16+
# maintainers:
17+
# - davidgarcia93
518

619
environment:
7-
sdk: '>=3.4.1 <4.0.0'
20+
sdk: ">=3.4.1 <4.0.0"
821
flutter: ">=1.17.0"
922

1023
dependencies:

0 commit comments

Comments
 (0)