doc-access 1.0.0 → 1.0.1

package/CODE_OF_CONDUCT.md

@@ -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.

package/CONTRIBUTE.md

@@ -0,0 +1,30 @@
+## Contributing
+When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
+2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
+3. Maintain the formatting as much as you can. [Formatting section](#formatting)
+4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
+
+### Formatting
+General
+- No manual obfuscation (gnioerbgoiwbrogiwrbogir)
+- One liners - 60 characters limit. (applies to everything). Exceptions: URLs. [Character counter](https://wordcounter.net/character-count)
+- Unnecessary framework usage that isn't already included won't be accepted
+- 4 spaces per indent level. Exceptions: see [Prettier ignore](.prettierignore)
+
+JavaScript
+- Do not manually edit generated JavaScript files; modify the source (TypeScript) instead
+
+Code comments
+- Explanatory code comments aren't allowed
+- General doesn't apply to code comments
+
+### Get missing dependencies
+- After cloning, install them by running the following:
+```
+npm install
+```

package/README.md

@@ -16,7 +16,7 @@ const main_elem = document.body.querySelector('main');
 
 const section = new Accessible_Section(
     "h2", // heading choice
-    main_elem,
+    main_elem, // section parent
     "Introduction"); // heading text
 
 const link = new Tab_Link(section.self,
@@ -27,15 +27,18 @@ const link = new Tab_Link(section.self,
 link.self.href = "https://example.com";
 
 const p = new Elem(
-    "p", 
-    section.self
+    "p", // can be any tag name
+    section.self // creation parent
     // optional id
 );
 p.self.textContent = "Hey there!";
 
-grouped_sections_accessible(".intro", "h2");
+grouped_sections_accessible(
+    ".intro", // class name
+    "h2" // heading choice
+);
 
-// access any heading with #id
+// access any heading under parent using its #id
 all_headings_nav_friendly(main_elem);
 
 const same_tab_link = new Elem("a", main_elem);
@@ -54,6 +57,10 @@ new_tab_existing(same_tab_link);
 new Accessible_Section();
 new Tab_Link();
 new Elem();
+
+// class methods
+attach();
+detach();
 ```
 
 ### Functions

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "doc-access",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "description": "A JS/TS module that reduces coding time spent on accessibility.",
     "license": "Apache-2.0",
     "author": "Placewith5s",