@setoelkahfi / tauri-plugin-admob / commits / cf99f6d

chore: contributing guidelines (#4)

* add CODEOWNERS * add CODE_OF_CONDUCT.md * add CONTRIBUTING.md

Lorenzo Rizzotti committed Mar 23, 2025 at 12:39 UTC cf99f6d6d307b81989cb1fbbd3f24d61aa3b97f1
3 files changed +222
.github/CODEOWNERS new
+1
@@ -0,0 +1 @@
1 +* @Dreaming-Codes
.github/CODE_OF_CONDUCT.md new
+128
@@ -0,0 +1,128 @@
1 +# Contributor Covenant Code of Conduct
2 +
3 +## Our Pledge
4 +
5 +We as members, contributors, and leaders pledge to make participation in our
6 +community a harassment-free experience for everyone, regardless of age, body
7 +size, visible or invisible disability, ethnicity, sex characteristics, gender
8 +identity and expression, level of experience, education, socio-economic status,
9 +nationality, personal appearance, race, religion, or sexual identity
10 +and orientation.
11 +
12 +We pledge to act and interact in ways that contribute to an open, welcoming,
13 +diverse, inclusive, and healthy community.
14 +
15 +## Our Standards
16 +
17 +Examples of behavior that contributes to a positive environment for our
18 +community include:
19 +
20 +* Demonstrating empathy and kindness toward other people
21 +* Being respectful of differing opinions, viewpoints, and experiences
22 +* Giving and gracefully accepting constructive feedback
23 +* Accepting responsibility and apologizing to those affected by our mistakes,
24 + and learning from the experience
25 +* Focusing on what is best not just for us as individuals, but for the
26 + overall community
27 +
28 +Examples of unacceptable behavior include:
29 +
30 +* The use of sexualized language or imagery, and sexual attention or
31 + advances of any kind
32 +* Trolling, insulting or derogatory comments, and personal or political attacks
33 +* Public or private harassment
34 +* Publishing others' private information, such as a physical or email
35 + address, without their explicit permission
36 +* Other conduct which could reasonably be considered inappropriate in a
37 + professional setting
38 +
39 +## Enforcement Responsibilities
40 +
41 +Community leaders are responsible for clarifying and enforcing our standards of
42 +acceptable behavior and will take appropriate and fair corrective action in
43 +response to any behavior that they deem inappropriate, threatening, offensive,
44 +or harmful.
45 +
46 +Community leaders have the right and responsibility to remove, edit, or reject
47 +comments, commits, code, wiki edits, issues, and other contributions that are
48 +not aligned to this Code of Conduct, and will communicate reasons for moderation
49 +decisions when appropriate.
50 +
51 +## Scope
52 +
53 +This Code of Conduct applies within all community spaces, and also applies when
54 +an individual is officially representing the community in public spaces.
55 +Examples of representing our community include using an official e-mail address,
56 +posting via an official social media account, or acting as an appointed
57 +representative at an online or offline event.
58 +
59 +## Enforcement
60 +
61 +Instances of abusive, harassing, or otherwise unacceptable behavior may be
62 +reported to the community leaders responsible for enforcement at
63 +me@dreaming.codes.
64 +All complaints will be reviewed and investigated promptly and fairly.
65 +
66 +All community leaders are obligated to respect the privacy and security of the
67 +reporter of any incident.
68 +
69 +## Enforcement Guidelines
70 +
71 +Community leaders will follow these Community Impact Guidelines in determining
72 +the consequences for any action they deem in violation of this Code of Conduct:
73 +
74 +### 1. Correction
75 +
76 +**Community Impact**: Use of inappropriate language or other behavior deemed
77 +unprofessional or unwelcome in the community.
78 +
79 +**Consequence**: A private, written warning from community leaders, providing
80 +clarity around the nature of the violation and an explanation of why the
81 +behavior was inappropriate. A public apology may be requested.
82 +
83 +### 2. Warning
84 +
85 +**Community Impact**: A violation through a single incident or series
86 +of actions.
87 +
88 +**Consequence**: A warning with consequences for continued behavior. No
89 +interaction with the people involved, including unsolicited interaction with
90 +those enforcing the Code of Conduct, for a specified period of time. This
91 +includes avoiding interactions in community spaces as well as external channels
92 +like social media. Violating these terms may lead to a temporary or
93 +permanent ban.
94 +
95 +### 3. Temporary Ban
96 +
97 +**Community Impact**: A serious violation of community standards, including
98 +sustained inappropriate behavior.
99 +
100 +**Consequence**: A temporary ban from any sort of interaction or public
101 +communication with the community for a specified period of time. No public or
102 +private interaction with the people involved, including unsolicited interaction
103 +with those enforcing the Code of Conduct, is allowed during this period.
104 +Violating these terms may lead to a permanent ban.
105 +
106 +### 4. Permanent Ban
107 +
108 +**Community Impact**: Demonstrating a pattern of violation of community
109 +standards, including sustained inappropriate behavior, harassment of an
110 +individual, or aggression toward or disparagement of classes of individuals.
111 +
112 +**Consequence**: A permanent ban from any sort of public interaction within
113 +the community.
114 +
115 +## Attribution
116 +
117 +This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118 +version 2.0, available at
119 +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120 +
121 +Community Impact Guidelines were inspired by [Mozilla's code of conduct
122 +enforcement ladder](https://github.com/mozilla/diversity).
123 +
124 +[homepage]: https://www.contributor-covenant.org
125 +
126 +For answers to common questions about this code of conduct, see the FAQ at
127 +https://www.contributor-covenant.org/faq. Translations are available at
128 +https://www.contributor-covenant.org/translations.
.github/CONTRIBUTING.md new
+93
@@ -0,0 +1,93 @@
1 +# Tauri Plugin Admob Contributing Guide
2 +
3 +Hi! We, the maintainers, are really excited that you're interested in contributing to Tauri Plugin Admob. Before submitting your
4 +contribution though, please make sure to take a moment and read through the [Code of Conduct](CODE_OF_CONDUCT.md), as
5 +well as the appropriate section for the contribution you intend to make:
6 +
7 +- [Issue Reporting Guidelines](#issue-reporting-guidelines)
8 +- [Development Guide](#development-guide)
9 +- [Pull Request Guidelines](#pull-request-guidelines)
10 +
11 +**We strongly advise you to join the [DreamingCodes Discord](https://discord.gg/MehYjUJGpA) to discuss your contribution
12 +with the community.**
13 +
14 +## Issue Reporting Guidelines
15 +
16 +- The issue list of this repo is **exclusively** for bug reports and feature requests. Non-conforming issues will be
17 + closed immediately.
18 +
19 +- If you have a question, you can get quick answers from the [DreamingCodes Discord](https://discord.gg/MehYjUJGpA).
20 +
21 +- Try to search for your issue, it may have already been answered or even fixed in the development branch (`main`).
22 +
23 +- Check if the issue is reproducible with the latest stable version. If you're using a pre-release, please
24 + indicate the specific version you're using.
25 +
26 +- It is **required** that you clearly describe the steps necessary to reproduce the issue you're running into. Although
27 + we would love to help our users as much as possible, diagnosing issues without clear reproduction steps is extremely
28 + time-consuming and simply not sustainable.
29 +
30 +- Use only the minimum amount of code necessary to reproduce the unexpected behavior. A good bug report should isolate
31 + specific methods that exhibit unexpected behavior and precisely define how expectations were violated. What did you
32 + expect the method or methods to do, and how did the observed behavior differ? The more precisely you isolate the
33 + issue, the faster we can investigate.
34 +
35 +- Issues with no clear repro steps will not be triaged. If an issue labeled "need repro" receives no further input from
36 + the issue author for more than 5 days, it will be closed.
37 +
38 +- If your issue is resolved but still open, don’t hesitate to close it. In case you found a solution by yourself, it
39 + could be helpful to explain how you fixed it.
40 +
41 +- Most importantly, we beg your patience: the team must balance your request against many other responsibilities —
42 + fixing other bugs, answering other questions, new features, new documentation, etc. The issue list is not paid
43 + support, and we can't make guarantees about how fast your issue can be resolved.
44 +
45 +## Development Guide
46 +
47 +Is this repository we stick to the following branch structure:
48 +
49 +| Branch | Description |
50 +|-|-|
51 +| `main` | The develop branch is where all the working branches are merged. It's not possible to push code directly here, not even for a maintainer. Everything in `main` must come from a pull request after a code review. |
52 +| `<working>` | Working branches are always created from `main` and to `main` shall return! Only working branches should be merged in to the develop branch after a code review. |
53 +
54 +## Pull Request Guidelines
55 +
56 +You must read the [Development Guide](#development-guide) section before proceeding with the pull request guidelines.
57 +
58 +In this project we stick to the following naming convention for the Pull Request title:
59 +
60 +```yml
61 +<type>: <short summary>
62 + │ │
63 + │ └─⫸ Summary: Present tense. Not capitalized. No period at the end.
64 + │
65 + └─⫸ Type: build|ci|docs|feat|fix|perf|refactor
66 +```
67 +
68 +##### Type must be one of the following:
69 +>* **build**: Changes that affect the build system or external dependencies (example scopes: gradle)
70 +>* **ci**: Changes to our CI configuration files and scripts (examples: Github Actions)
71 +>* **docs**: Documentation only changes
72 +>* **feat**: A new feature
73 +>* **fix**: A bug fix
74 +>* **perf**: A code change that improves performance
75 +>* **refactor**: A code change that neither fixes a bug nor adds a feature
76 +
77 +##### Summary
78 +>Use the summary field to provide a succinct description of the change:
79 +>
80 +>* use the imperative, present tense: "change" not "changed" nor "changes"
81 +>* don't capitalize the first letter
82 +>* no dot (.) at the end
83 +
84 +**You must follow this convention also for the working branch name: `<type>/<summary>`, e.g. `build/migrate_gradle`.**
85 +
86 +##### Some clarifications
87 +>- It's OK to have multiple small commits as you work on the PR – We will let GitHub automatically squash it before
88 + > merging. (That is why we're restrictive about the title of the PR)
89 +>
90 +>- If adding new feature:
91 + >
92 + > - Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it
93 + > greenlighted before working on it.