-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #15 from MOB-atheist/MOB-atheist-patch-1
Create CONTRIBUTING.md and CODE_OF_CONDUCT.md
- Loading branch information
Showing
3 changed files
with
233 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
# Code of Conduct - FrontEnd Grimoire | ||
|
||
## 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 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 | ||
* 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 | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying and enforcing our standards of | ||
acceptable behavior and will 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 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. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version | ||
[1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and | ||
[2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md), | ||
and was generated by [contributing-gen](https://github.com/bttger/contributing-gen). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,108 @@ | ||
# Contributing to FrontEnd Grimoire | ||
|
||
Hey you!!! Yes you... ⛏️ Unleash Your Inner Dwarf - Contribute with Grit! ⛏️ | ||
|
||
Ahoy, brave wanderer! Grab your tools – pickaxe, shovel, or bare hands – and delve into the heart of our project. Lost? Consult the Magic Spells Glossary. For those seeking a different rock, navigate the words; we speak English, but Gibberish is our true tongue. Contribute your wisdom, and let the dwarven celebration begin! 🎉 | ||
|
||
> Fear Not, Apprentice! Cast Your Supporting Spells, If the thought of battling goblins in the depths of the mine gives you shivers, fret not! Channel your magical energies into these enchanting spells to aid our quest: | ||
> - 🌟 Star the Project: Gently shower us with your stardust by starring the project. Aim not for our pointy heads; let the stars align in harmony. | ||
> - 🐦 Tweet the Magic: Harness the power of social media – tweet about our endeavor! They say it brings blessings and a touch of distress, but in the realm of code, we embrace the unpredictability. A gamble worth taking! | ||
> - 📜 Project Crossroads: Inscribe our tale in the ancient scrolls of project READMEs. Let the world remember the folly and triumph of this journey. | ||
> - 🗣️ Summon Allies: Spread the word in the taverns of local meetups. Shout from the mountaintops to friends and colleagues. Should you wish their presence in our realm, advise them to don helmets – safety first in the code-forging adventure! | ||
> | ||
> Your enchantments shall echo through the corridors of contribution, leaving a trail of magic in your wake! 🌌✨ | ||
|
||
## 📜 Dwarven Codex: Table of Enchantments 📜 | ||
|
||
- [🔮 Code of Conduct](#code-of-conduct): *Guidelines to maintain harmony in our enchanted caverns. No stone unturned, no spell misused.* | ||
- [❓ I Have a Question](#i-have-a-question): *Pose your queries here and let the knowledge flow like the river of molten gold.* | ||
- [⛏️ I Want To Dig](#i-want-to-contribute): *This passage reveals the secrets to join our fellowship.* | ||
- [🐛 Reporting Bugs and Goblins](#reporting-bugs): *Fear not! Here's the spell to report the evil.* | ||
- [🌟 Suggesting Enhancements](#suggesting-enhancements): *Cast your visions here and let the magic of enhancement unfold.* | ||
- [💎 Your First Gold Nugget to be Found](#your-first-code-contribution): *Uncover the secrets of forging your first golden nugget.* | ||
- [📏 Styleguides](#styleguides): *Craft your runes with precision!* | ||
- [📝 Commit Messages](#commit-messages): *Inscribe your magical deeds in the chronicles of commit messages.* | ||
- [👥 Join The Project Team](#join-the-project-team): *Assemble, ye dwarven kin! Learn the ways to join our project team and forge alliances in the realms.* | ||
|
||
<a id="code-of-conduct"></a> | ||
## ⚔️ Code of Conduct: Behold the Grimoire of Respect | ||
|
||
In the sacred tome of the dwarven code, known as the "FrontEnd Grimoire Code of Conduct," lies the wisdom of navigating our enchanted realms. This mystical book, though known to induce slumber, harbors crucial teachings. Should you dare to venture, you can unlock its secrets [here](https://github.com/MOB-atheist/FrontEnd-Grimoireblob/master/CODE_OF_CONDUCT.md). | ||
|
||
Beware, for within these pages, mermaids and other mystical beings are not to be trifled with. A stern warning echoes through the corridors: "Thou shalt not engage in mischief with the aquatic denizens." | ||
|
||
Should you witness a rogue soul dancing with goblin-like tendencies, fear not! Seek out the stalwart dwarfs dwelling in the caverns. They stand ready to wield their moderation powers and restore the balance of respect in our sacred abode. | ||
|
||
May the Grimoire guide you through the labyrinth of proper conduct as you embark on your noble quest in our realms! 📘🛡️ | ||
|
||
<a id="i-have-a-question"></a> | ||
## 🔮 I Have a Question: Unveiling the Mysteries 🔮 | ||
|
||
> Should the labyrinth of the mine leave you perplexed, fear not, brave seeker! In our mining abode, the dwarfs stand ready to unravel the mysteries. If our faces contort into strange visages during inquiries, gaze not upon us but seek the wisdom of the -> [Wizards College](google.com). | ||
Before making a question, its adviced you look into our board of [Issues](https://github.com/MOB-atheist/FrontEnd-Grimoire/issues), We also have some goblin hunting missions there. In case you have found a issue, go tell your mother... just kidding write us a letter there and we'll look into it. | ||
|
||
If you got here and sill need some advice, we could give you some potions in the future: | ||
|
||
- Write us a [Letter](https://github.com/MOB-atheist/FrontEnd-Grimoire/issues/new). | ||
- Tells us how you feel about it in details, this is important sice dwarfs dont have compassion and we may find it dificult to understand emotions. | ||
|
||
<a id="i-want-to-contribute"></a> | ||
## I⛏️ I WANT TO DIG A HOLE ⛏️ | ||
|
||
> ### Embarking on a quest to carve through the digital bedrock? Venture forth, but heed the sacred words etched in the Bullsh*t Notice: | ||
> 🚨 Disclaimer: When your pickaxe descends into the depths, and gold sparkles before your eyes, know this: the treasures unearthed are solely your responsibility. The laws of our project license and, dare we say, the mortal law itself shall govern your newfound wealth. | ||
> May your digging be fruitful, and the veins of code you discover be rich with untold treasures! ⚒️💰 | ||
<a id="reporting-bugs"></a> | ||
### 🐞 Reporting Bugs And Goblins: A Cry in the Coding Abyss 🐲 | ||
|
||
#### Before Submitting a Bug Report | ||
|
||
> Embarking on a bug-hunting mission requires precision and diligence. Before unleashing your findings upon the dwarven council, take heed of these sacred instructions: | ||
##### 🌌 Preparing for the Quest: | ||
|
||
- **🖊️ Equip a Mighty Pen:** *Ensure your writing tool rivals a dwarven warhammer. A reliable pen leaves no room for ambiguity in your scrolls.* | ||
- **🐜 Bug or Mere Disguise? Verify:**: *Distinguish true bugs from impostors! If in doubt, consult the [I Have a Question](#i-have-a-question) oracle for a tea session.* | ||
- **📋 Check the Mission Board:** *Explore the [bug tracker](https://github.com/MOB-atheist/FrontEnd-Grimoireissues?q=label%3Abug) for kin with similar quests. Unity in mission brings strength.* | ||
- **🔮 Consult the Wizards Tower:** *Ascend the [Google](google.com) tower to glean wisdom. The wizards might have unraveled the mysteries you seek.* | ||
|
||
#### ✉️ Crafting a Letter of Merit: | ||
|
||
> Inscribe your missives with care, noble contributor, for a well-crafted letter holds the power to illuminate even the darkest coding caverns. | ||
> Should your message involve delicate matters or discoveries of undergarments, refrain from the quill. Entrust the secrets to a messenger pigeon, ensuring safe delivery to [address](nomad2019damn@gmail.com). | ||
<a id="suggesting-enhancements"></a> | ||
### 🚀 Suggesting Enhancements: Forging New Horizons 🚀 | ||
|
||
Venture forth, intrepid coder, into the realms of enhancement suggestion! Whether crafting entirely new features or refining existing enchantments, this passage illuminates the path to contribute to the evolution of FrontEnd Grimoire. | ||
|
||
<a id="your-first-code-contribution"></a> | ||
#### 🌌 Before Submitting an Enhancement: A Prelude to Enchantment 🌌 | ||
|
||
- **📖 Codex of Wisdom:** *Immerse yourself in the [documentation](https://github.com/MOB-atheist/FrontEnd-Grimoire). Ascertain if the realms of your envisioned enhancement are already charted within these sacred scrolls.* | ||
- **🔍 Scrolls of Recognition:** *Traverse the [Issues board](https://github.com/MOB-atheist/FrontEnd-Grimoire/issues). Ascertain whether the enhancement has been summoned before. If so, add your insights to the existing summoning rather than conjuring a new one.* | ||
- **🌐 Project's True North:** *Align your enhancement with the grand tapestry of FrontEnd Grimoire. Seek whether your mystical addition resonates with the project's scope and aspirations. Craft a compelling case to persuade the developers of its magical merits.* | ||
- **🌟 Universal Appeal:** *Envision enhancements that illuminate the path for the majority of our users. Remember, we seek features that bring magic to the masses. If your vision caters to a minority, consider weaving it into an add-on or a magical plugin library.* | ||
|
||
#### 🌌 How Do I Submit a Good Enhancement Suggestion? 🌟 | ||
|
||
##### [GitHub issues](https://github.com/MOB-atheist/FrontEnd-Grimoire/issues). *The sacred scrolls where enhancement suggestions take form. Navigate this portal to witness the tapestry of ideas and contribute your own enchantments.* | ||
|
||
- **🌟 Title Incantation:** *Bestow upon your enhancement suggestion a title of clarity and enchantment. Let it resonate with the magic it promises.* | ||
- **🗺️ Path of Illumination:** *Unveil the suggestion with a detailed description. Chart a step-by-step path through the mystical enhancement, revealing its secrets like a guide through the enchanted forest.* | ||
- **⚙️ Current vs. Envisioned Realms:** *Paint a vivid portrait of the existing behavior and articulate the transformation you seek. Explain the expected behavior, and why it resonates more profoundly with your vision. Illuminate the alternatives that failed to conjure the desired magic.* | ||
- **📸 Visual Glyphs (Optional):** *If the arcane arts permit, include visual glyphs such as screenshots or animated GIFs. Use tools like [LICEcap](https://www.cockos.com/licecap/) for macOS and Windows, or [Silentcast](https://github.com/colinkeenan/silentcast) and [Byzanz](https://github.com/GNOME/byzanz) for Linux to capture the essence of your enchantment.* | ||
- **🤔 Utility to the Many:** *Articulate the essence of why this enhancement is not merely a whim but a profound boon to the majority of FrontEnd Grimoire users. Illuminate the path by showcasing projects that have mastered similar magic, serving as beacons of inspiration.* | ||
|
||
<a id="styleguides"></a> | ||
## Styleguides | ||
<a id="commit-messages"></a> | ||
### Commit Messages | ||
<!-- TODO --> | ||
|
||
<a id="join-the-project-team"></a> | ||
## Join The Project Team | ||
<!-- TODO --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,60 @@ | ||
<h1 align="center"> Front End Grimoire </h1> | ||
|
||
<div align="center"> | ||
<img src="images/mystical_book.png" height="200px" /> | ||
<img src="images/mystical_book.png" height="300px" /> | ||
</div> | ||
|
||
This repository is a collection of knowledge aquired by everyone involved on its making, feel free to request to join us. | ||
|
||
## Documents | ||
|
||
<ul> | ||
<li> | ||
<a href="JAVASCRIPT.md">Javascript</a> | ||
<ul> | ||
<li><a href="JAVASCRIPT.md#usefull-links">Usefull Link</a></li> | ||
<li><a href="JAVASCRIPT.md#javascript-odities">Odities</a></li> | ||
</ul> | ||
</li> | ||
<li> | ||
<a href="REACTJS.md">React.js</a> | ||
<ul> | ||
<li><a href="REACTJS.md#usefull-links">Usefull Link</a></li> | ||
</ul> | ||
</li> | ||
<li><a href="LINKS.md">Usefull links in general</a></li> | ||
</ul> | ||
|
||
## Sources | ||
|
||
- [sitepoint](https://www.sitepoint.com/shorthand-javascript-techniques/) | ||
- [devdojo](https://devdojo.com/emmaturner/20-javascript-shorthand-to-save-time) | ||
- [Fireshit](https://youtu.be/TNhaISOUy6Q) | ||
- [Product hunt](https://www.producthunt.com/) | ||
- [insha](https://dev.to/insha/the-ultimate-cheat-sheet-list-for-web-developers-2i9i) | ||
<p align="center">In the ever-expanding tapestry of knowledge, this grimoire is a synthesis of diverse languages and environments, a beacon to illuminate the pathways of understanding for those who navigate the realms of code.</p> | ||
|
||
<p align="center">As it stands, our grimoire is but a humble collection, yearning to grow and evolve. Your contribution is not merely welcomed but revered. Venture forth into the sacred scrolls of <a href="CONTRIBUTING.md">Contributions</a> and immerse yourself in the guiding principles. Here, every incantation and enchantment adds a verse to the magical hymn of collective knowledge.</p> | ||
|
||
<p align="center">Yet, let not the pursuit of wisdom obscure the path of respect and camaraderie. Behold the <a href="CODE_OF_CONDUCT.md">Code of conduct</a>, a code of honor that unites the denizens of this mystical realm.</p> | ||
|
||
<p align="center">May your presence in this grimoire be a testament to the collaborative spirit, and may the magic you weave resonate across the coding realms! 🌌📖</p> | ||
|
||
<h2 align="center">Documents</h2> | ||
|
||
<h3 align="center"> | ||
❖ <a href="JAVASCRIPT.md">Javascript</a> ❖ | ||
</h3> | ||
|
||
<h5 align="center"> | ||
✦ <a href="JAVASCRIPT.md#usefull-links">Usefull Link</a> | ||
</h5> | ||
|
||
<h5 align="center"> | ||
✦ <a href="JAVASCRIPT.md#javascript-odities">Odities</a> | ||
</h5> | ||
|
||
<h3 align="center"> | ||
❖ <a href="REACTJS.md">React.js</a> ❖ | ||
</h3> | ||
|
||
<h5 align="center"> | ||
✦ <a href="REACTJS.md#usefull-links">Usefull Link</a> | ||
</h5> | ||
|
||
<h3 align="center"> | ||
❖ <a href="LINKS.md">Usefull links in general</a> ❖ | ||
</h3> | ||
|
||
<p align="center">Thank you for taking your time to read this projects content, we hope it was something of value to you.</p> | ||
|
||
<h2 align="center">Sources</h2> | ||
|
||
<h5 align="center"> | ||
❖ <a href="https://www.sitepoint.com/shorthand-javascript-techniques/">sitepoint</a> | ||
</h5> | ||
<h5 align="center"> | ||
❖ <a href="https://devdojo.com/emmaturner/20-javascript-shorthand-to-save-time">devdojo</a> | ||
</h5> | ||
<h5 align="center"> | ||
❖ <a href="https://youtu.be/TNhaISOUy6Q">Fireshift</a> | ||
</h5> | ||
<h5 align="center"> | ||
❖ <a href="https://www.producthunt.com/">Product hunt</a> | ||
</h5> | ||
<h5 align="center"> | ||
❖ <a href="https://dev.to/insha/the-ultimate-cheat-sheet-list-for-web-developers-2i9i">insha</a> | ||
</h5> | ||
|