Skip to content

Latest commit

 

History

History
119 lines (87 loc) · 6.68 KB

contributing.md

File metadata and controls

119 lines (87 loc) · 6.68 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owner of this repository before making a change.

We have a code of conduct that you are expected to folllow.

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. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we currently use is SemVer.
  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.

Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • The use of sexual language or imagery and unwelcome sexual attention or advances
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to 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 both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [INSERT EMAIL ADDRESS]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4


Overview of this app

This is a tool for people with reduced motor skills who find using a technology assisted mouse easier than using a keyboard. Tjhat is the main focus that should drive any and all improvements to the app.

Wish list items

  1. Up and down arrow keys
  2. User supplied file uploads
  3. Choose alphabetical word count output
  4. Keyboard layouts by language

Up and down arrow keys

This is not essential but it would be nice to have. They would be used when a user notices a mis-spelling and clicks near the word to make a correction but clicks the wrong row of text. The right and left arrows can be used to get to the part of the word that needs to be replaced or removed.

User supplied file uploads

I had to load user-supplied content into local storage but I do not like that option. Let me know if you have a solution for that keeping in mind that this app will re running on local machines. One solution is to get an organization to host the app allowing users to upload their files to servers.

Choose alphabetical word count output

In my opinion 15-20 words per letter of the alphabet is too few and 100+ is too many. You don't want so many words that the megamenu if larger than the viewport height. Plus it would be hard to remember which words are under each letter. I don't know what the optimum number is, and that may change for each user. It would be nice for the user to view the output of their file upload, and then increase or decrease the amount of words by changing the character count cutoff.

For example, I chose not to include words with 3 or less characters. An input field of type="number" should do the trick. Then a user could tweak the character count to get a list of words that is not too small or too big.

Keyboard layouts by language

I would like to involve developers from other countries who could contribute to building a keyboard for people from their country. I would then have to creeate a select list of possible keyboard layouts to choose from. Translations for all page text would be needed, as well as the default words and phrases in content.js and text-default.txt.

Also, the HTML, CSS, and JavaScript would most likely need to be modified to account for different keyboard layouts. For example, the SHIFT key would be needed for more or less keys to display alternate values. Each row of the keyboard is set to display of flex. If more keys need to be added, then changes to the HTML file will be required.