Skip to content

Commit a5254d0

Browse files
JorchCortezJorchCortez
committed
2 parents 0696db1 + 037752f commit a5254d0

2 files changed

Lines changed: 249 additions & 2 deletions

File tree

‎CODE_OF_CONDUCT.md‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our
7+
community a harassment-free experience for everyone, regardless of age, body
8+
size, visible or invisible disability, ethnicity, sex characteristics, gender
9+
identity and expression, level of experience, education, socio-economic status,
10+
nationality, personal appearance, race, caste, color, religion, or sexual
11+
identity and orientation.
12+
13+
We pledge to act and interact in ways that contribute to an open, welcoming,
14+
diverse, inclusive, and healthy community.
15+
16+
## Our Standards
17+
18+
Examples of behavior that contributes to a positive environment for our
19+
community include:
20+
21+
* Demonstrating empathy and kindness toward other people
22+
* Being respectful of differing opinions, viewpoints, and experiences
23+
* Giving and gracefully accepting constructive feedback
24+
* Accepting responsibility and apologizing to those affected by our mistakes,
25+
and learning from the experience
26+
* Focusing on what is best not just for us as individuals, but for the overall
27+
community
28+
29+
Examples of unacceptable behavior include:
30+
31+
* The use of sexualized language or imagery, and sexual attention or advances of
32+
any kind
33+
* Trolling, insulting or derogatory comments, and personal or political attacks
34+
* Public or private harassment
35+
* Publishing others' private information, such as a physical or email address,
36+
without their explicit permission
37+
* Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
40+
## Enforcement Responsibilities
41+
42+
Community leaders are responsible for clarifying and enforcing our standards of
43+
acceptable behavior and will take appropriate and fair corrective action in
44+
response to any behavior that they deem inappropriate, threatening, offensive,
45+
or harmful.
46+
47+
Community leaders have the right and responsibility to remove, edit, or reject
48+
comments, commits, code, wiki edits, issues, and other contributions that are
49+
not aligned to this Code of Conduct, and will communicate reasons for moderation
50+
decisions when appropriate.
51+
52+
## Scope
53+
54+
This Code of Conduct applies within all community spaces, and also applies when
55+
an individual is officially representing the community in public spaces.
56+
Examples of representing our community include using an official email address,
57+
posting via an official social media account, or acting as an appointed
58+
representative at an online or offline event.
59+
60+
## Enforcement
61+
62+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63+
reported to the community leaders responsible for enforcement at
64+
[INSERT CONTACT METHOD].
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series of
87+
actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or permanent
94+
ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within the
114+
community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.1, available at
120+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
121+
122+
Community Impact Guidelines were inspired by
123+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
127+
[https://www.contributor-covenant.org/translations][translations].
128+
129+
[homepage]: https://www.contributor-covenant.org
130+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
131+
[Mozilla CoC]: https://github.com/mozilla/diversity
132+
[FAQ]: https://www.contributor-covenant.org/faq
133+
[translations]: https://www.contributor-covenant.org/translations

‎README.md‎

Lines changed: 116 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,116 @@
1-
# WebflowTrickery
2-
Webflow Trickery is an Open Source project focused on creating reusable functionalities for web platforms and developers out there
1+
<p align="center">
2+
<a href="https://github.com/TheCodeRaccoons/WebflowTrickery/releases">
3+
<img alt="GitHub release (latest by semver)" src="https://img.shields.io/github/v/release/TheCodeRaccoons/WebflowTrickery?color=%2360be86&label=Latest%20release&style=for-the-badge&sort=semver">
4+
</a>
5+
<a href="/LICENSE">
6+
<img alt="GitHub" src="https://img.shields.io/github/license/TheCodeRaccoons/WebflowTrickery?color=%2360be86&style=for-the-badge">
7+
</a>
8+
<a href="https://github.com/TheCodeRaccoons/WebflowTrickery/graphs/contributors">
9+
<img alt="GitHub contributors" src="https://img.shields.io/github/contributors-anon/TheCodeRaccoons/WebflowTrickery?color=%2360be86&style=for-the-badge">
10+
</a>
11+
<a href="https://github.com/TheCodeRaccoons/WebflowTrickery/issues/new?assignees=&labels=Functionality+Request&projects=&template=request-functionality.yml&title=%5BFUNCTIONALITY+REQUEST%5D%3A+request+name">
12+
<img alt="GitHub issues by-label" src="https://img.shields.io/github/issues/TheCodeRaccoons/WebflowTrickery/request:feature?color=%2360be86&label=feature%20requests&style=for-the-badge">
13+
</a>
14+
<a href="https://github.com/TheCodeRaccoons/WebflowTrickery/stargazers">
15+
<img alt="GitHub repository stars" src="https://img.shields.io/github/stars/TheCodeRaccoons/WebflowTrickery?color=%2360be86&label=github%20stars&style=for-the-badge">
16+
</a>
17+
</p>
18+
<br />
19+
<div align="center">
20+
<a href="https://github.com/TheCodeRaccoons/WebflowTrickery">
21+
<img src="https://raw.githubusercontent.com/TheCodeRaccoons/Imagery/16a395115ab598a94a7d1ab93f182218d8bbb751/wt-logo.svg" alt="Webflow Trickery Logo" height="140" />
22+
</a>
23+
<h5 align="center">
24+
Webflow Trickery aims to create easy to implement, reusable functionalities for the web. As it's name implies, the main platform this project targets is <a href="https://webflow.com/">Webflow</a>, but the majority of the scripts are made with general web development in mind. Meaning that most of this scripts should work without an issue on any website unless it is a CMS functionality or a Webflow specific script.
25+
</h5>
26+
<p align="center">
27+
<a target="_blank" href="https://github.com/TheCodeRaccoons/WebflowTrickery/issues/new/choose">Request a functionality</a>
28+
&middot;
29+
<a href="#contribute">Contribute</a>
30+
</p>
31+
</div>
32+
33+
<h2>TL;DR</h2>
34+
All of the documentation is explained by functionality in <a href="https://coderacoons.webflow.io/tools/webflow-trickery">the website</a>. Feel free to browse there or request any aditional functionalities in the <a target="_blank" href="https://github.com/TheCodeRaccoons/WebflowTrickery/issues/new/choose">issues</a> section of this project.
35+
36+
<h2>Table of Contents</h2>
37+
<ol>
38+
<li><a href="#about">About the Project</a></li>
39+
<li><a href="#getting-started">Getting Started</a></li>
40+
<li><a href="#request-functionality">Requesting a Functionality</a></li>
41+
<li><a href="#contribute">Contributing</a></li>
42+
<li><a href="#discord-community">Discord Community</a></li>
43+
<li><a href="#develop-vs-master"><code>develop</code> vs <code>master</code></a></li>
44+
<li><a href="#stale-prs">Stale Pull Requests</a></li>
45+
</ol>
46+
47+
<h2 id="about">About the Project</h2>
48+
<p>
49+
As any other developer using no-code web design tools I've struggled with the ability to bring specific, more complex functionalities to platforms like Webflow.
50+
<br/><br/>
51+
Over the past couple of years I started noticing some of this functionalities are not only commonly used but also requested by many in the community. Webflow trickery aims to empower developers and designers alike, provinding both simple and complex functionalities that could, in other cases, take longer to develop from scratch.
52+
<br/><br/>
53+
This being said even though most of this functionalities are built for Webflow, there's many that can be used in any other web project and platform. Feel free to see the full <a href="https://coderacoons.webflow.io/tools/webflow-trickery">documentation</a> in our site for the complete list of functionalities and scripts available.
54+
</p>
55+
<sub>
56+
Webflow Trickery might have been started as a personal project, but I'm a believer that a project for the comunity by the comunity can offer way more value than any single dev could provide so feel free to contribute to this project and use any solution here.
57+
</sub>
58+
59+
<h2 id="getting-started">Getting Started</h2>
60+
61+
```html
62+
Include each script or pack scripts together.
63+
For a faster load, download the scripts and add to your project
64+
packages will be added in a future version
65+
```
66+
67+
<h2 id="request-functionality">Requesting a functionality</h2>
68+
<p>
69+
When you want to request a new functionality please feel free to create an issue. Check out our <a href="https://github.com/TheCodeRaccoons/WebflowTrickery/wiki/Requesting-a-Finctionality">Wiki</a> for more information.
70+
</p>
71+
72+
<h2 id="contribute">Contributing</h2>
73+
<p>
74+
We are happy with every contribution, whether it's new functionalities, fixes, features, or maintainers. Please have a look at our <a href="https://github.com/TheCodeRaccoons/WebflowTrickery/wiki">Wiki</a> to see how you can contribute to this project.
75+
</p>
76+
77+
<h2 id="discord-community">Discord community</h2>
78+
<p>
79+
We are building a community on discord. You can easily discuss, and have a good time talking with the community members! an official discord link will be released in a later date to allow the community to chat.
80+
</p>
81+
82+
<h2 id="develop-vs-master"><code>develop</code> vs <code>master</code></h2>
83+
<p>
84+
All official releases shall be in <code>master</code>. Any updates in between (updates, new functionalities, features, etc.) will be kept in <code>develop</code>.
85+
</p>
86+
<b><code>develop</code> contains:</b>
87+
<ul>
88+
<li>
89+
Latest functions, lightly optimized, throughly tested.
90+
</li>
91+
<li>
92+
No full docs in the website for this functions, they will be released with the latest release, though the dev branch will have it's own.<br>
93+
</li>
94+
<li>
95+
Experimental changes.
96+
</li>
97+
</ul>
98+
<b><code>master</code> contains:</b>
99+
<ul>
100+
<li>
101+
Latest official release, including all functionalities, well optimized and under support.
102+
</li>
103+
<li>
104+
Official, well tested changes.
105+
</li>
106+
</ul>
107+
108+
<h2 id="stale-prs">Stale Pull Requests</h2>
109+
<p>
110+
After a pull request has been open for over 30 days with no activity or response from the author, it'll be automatically marked as stale. We might fork your changes and merge the changes ourselves. Since GitHub tracks contributions by commits, you will be credited.
111+
</p>
112+
<br/>
113+
<div align="center">
114+
<img src="https://forthebadge.com/images/badges/built-with-love.svg" />
115+
<img src="https://forthebadge.com/images/badges/built-by-developers.svg" />
116+
</div>

0 commit comments

Comments
 (0)