Compare commits
10 Commits
f90a0738f1
...
082bbc6e4a
Author | SHA1 | Date | |
---|---|---|---|
|
082bbc6e4a | ||
|
fc3e82380e | ||
|
569b64acba | ||
|
d5d49aee67 | ||
|
e25fc1f99e | ||
|
7dd6964f50 | ||
|
a9c2dc1244 | ||
|
9d215319b6 | ||
|
bed97d702d | ||
|
602a575393 |
5
.github/CONTRIBUTING.md
vendored
Normal file
5
.github/CONTRIBUTING.md
vendored
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
Please check out the following resources:
|
||||||
|
|
||||||
|
* [Info For Developers](../README.md#for-developers)
|
||||||
|
* [FAQ](../README.md#FAQ)
|
||||||
|
* [Code of Conduct](../CODE_OF_CONDUCT.md)
|
3
.github/ISSUE_TEMPLATE/bug_report.md
vendored
3
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@ -4,6 +4,9 @@ about: Create a report to help us improve
|
|||||||
labels:
|
labels:
|
||||||
|
|
||||||
---
|
---
|
||||||
|
*please search the issues for duplicates and read the [FAQ](/witch-house/pronoun.is/blob/master/README.md#FAQ)
|
||||||
|
before submitting a new issue :)*
|
||||||
|
|
||||||
|
|
||||||
**Describe the bug**
|
**Describe the bug**
|
||||||
A clear and concise description of what the bug is.
|
A clear and concise description of what the bug is.
|
||||||
|
2
.github/ISSUE_TEMPLATE/feature_request.md
vendored
2
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@ -4,6 +4,8 @@ about: Suggest an idea for this project
|
|||||||
labels:
|
labels:
|
||||||
|
|
||||||
---
|
---
|
||||||
|
*please search the issues for duplicates and read the [FAQ](/witch-house/pronoun.is/blob/master/README.md#FAQ)
|
||||||
|
before submitting a new issue :)*
|
||||||
|
|
||||||
**Is your feature request related to a problem? Please describe.**
|
**Is your feature request related to a problem? Please describe.**
|
||||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||||
|
8
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
8
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
*Thanks for contributing! Please check the following things before submitting your PR :)*
|
||||||
|
|
||||||
|
- [ ] PR message includes a link to the relevant issue(s) 💁♀️🖇️🧾
|
||||||
|
- [ ] Commit messages are well-formatted
|
||||||
|
(please follow [this guide](https://chris.beams.io/posts/git-commit/)) 📝📐
|
||||||
|
- [ ] New features have test coverage 📋☑️☑️☑️
|
||||||
|
- [ ] The app boots and pronoun pages are served correctly
|
||||||
|
(try `lein ring server`) 👩💻🚀
|
76
CODE_OF_CONDUCT.md
Normal file
76
CODE_OF_CONDUCT.md
Normal file
@ -0,0 +1,76 @@
|
|||||||
|
# Contributor Covenant 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, 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 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 sexualized 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 maintainer, @morganastra. 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][homepage], version 1.4,
|
||||||
|
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
||||||
|
|
||||||
|
[homepage]: https://www.contributor-covenant.org
|
||||||
|
|
||||||
|
For answers to common questions about this code of conduct, see
|
||||||
|
https://www.contributor-covenant.org/faq
|
@ -1 +0,0 @@
|
|||||||
See "[For Developers](README.md#for-developers)" in the README
|
|
63
README.md
63
README.md
@ -1,4 +1,28 @@
|
|||||||
**[pronoun.is](https://pronoun.is) is a website for personal pronoun usage examples**
|
# pronoun.is
|
||||||
|
|
||||||
|
[pronoun.is](https://pronoun.is) is a website for personal pronoun usage examples
|
||||||
|
|
||||||
|
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
|
||||||
|
**Table of Contents**
|
||||||
|
|
||||||
|
- [pronoun.is](#pronounis)
|
||||||
|
- [For users](#for-users)
|
||||||
|
- [For developers](#for-developers)
|
||||||
|
- [The database](#the-database)
|
||||||
|
- [The code](#the-code)
|
||||||
|
- [Tests](#tests)
|
||||||
|
- [Running the app in a dev environment](#running-the-app-in-a-dev-environment)
|
||||||
|
- [The git repo](#the-git-repo)
|
||||||
|
- [Philosophy on pronoun inclusion](#philosophy-on-pronoun-inclusion)
|
||||||
|
- [FAQ](#faq)
|
||||||
|
- [Can we translate pronoun.is into another language?](#can-we-translate-pronounis-into-another-language)
|
||||||
|
- [Can we change the example sentences?](#can-we-change-the-example-sentences)
|
||||||
|
- [Can we add pronunciation guides?](#can-we-add-pronunciation-guides)
|
||||||
|
- [Can we add pluralization support (i.e. themself vs themselves)](#can-we-add-pluralization-support-ie-themself-vs-themselves)
|
||||||
|
- [License](#license)
|
||||||
|
|
||||||
|
<!-- markdown-toc end -->
|
||||||
|
|
||||||
|
|
||||||
## For users
|
## For users
|
||||||
|
|
||||||
@ -99,6 +123,43 @@ Pronoun.is aims foremost and exclusively to be a useful resource for people to c
|
|||||||
It is possible to use these example sentences to demonstrate the usage of words that are not personal pronouns, or even cleverly insert an [entire story](https://pronoun.is/she/or%20they,%20those%20ships%20who%20were%20docked%20and%20still%20equipped%20with%20ancillaries,%20arranged%20to%20share%20the%20duty%20of%20monitoring%20our%20guest%20as%20it%20fit%20into%20their%20routines;%20that%20was%20the%20agreement,%20despite%20it%20being%20less%20convenient%20for%20me%20to%20participate%20at%20all,%20on%20the%20grounds%20that%20certain%20visitors%20might%20prefer%20a%20constant%20individual%20companion%20to%20what%20might%20seem,%20depending%20on%20their%20past%20experiences,%20to%20be%20undue%20attention%20from%20every%20soldier%20they%20passed.%20As%20usual,%20then,%20I%20took%20the%20first%20shift/the%20one%20possession%20of%20hers%20that%20Station%20Security%20hadn't%20confiscated,%20a/knowingly%20left%20with%20her.%20What%20a%20Presger%20frisbee%20might%20do%20or%20even%20look%20like%20I%20couldn't%20say.%20She%20hadn't%20seemed%20the%20sort%20to%20have%20alien%20technology,%20but,%20then%20again,%20neither%20had%20I/another%20unremarkable%20stranger,%20quite%20a%20ways%20down%20the%20concourse,%20who%20caught%20it%20with%20a%20degree%20of%20coordination%20that%20most%20would%20have%20overlooked.%20It%20did%20not%20escape%20my%20notice,%20however.%20"Cousin,"%20I%20said,%20enough%20to%20convey%20-%20unless%20our%20visitor%20were%20quite%20ignorant,%20but,%20of%20course,%20at%20this%20point%20I%20was%20certain%20that%20she%20couldn't%20be%20-%20both%20that%20I%20knew%20what%20she%20was%20not%20and%20that%20I%20was%20giving%20her%20the%20benefit%20of%20the%20doubt%20as%20to%20what,%20or%20who,%20she%20was)! However, as a policy we will not include such entries in the database.
|
It is possible to use these example sentences to demonstrate the usage of words that are not personal pronouns, or even cleverly insert an [entire story](https://pronoun.is/she/or%20they,%20those%20ships%20who%20were%20docked%20and%20still%20equipped%20with%20ancillaries,%20arranged%20to%20share%20the%20duty%20of%20monitoring%20our%20guest%20as%20it%20fit%20into%20their%20routines;%20that%20was%20the%20agreement,%20despite%20it%20being%20less%20convenient%20for%20me%20to%20participate%20at%20all,%20on%20the%20grounds%20that%20certain%20visitors%20might%20prefer%20a%20constant%20individual%20companion%20to%20what%20might%20seem,%20depending%20on%20their%20past%20experiences,%20to%20be%20undue%20attention%20from%20every%20soldier%20they%20passed.%20As%20usual,%20then,%20I%20took%20the%20first%20shift/the%20one%20possession%20of%20hers%20that%20Station%20Security%20hadn't%20confiscated,%20a/knowingly%20left%20with%20her.%20What%20a%20Presger%20frisbee%20might%20do%20or%20even%20look%20like%20I%20couldn't%20say.%20She%20hadn't%20seemed%20the%20sort%20to%20have%20alien%20technology,%20but,%20then%20again,%20neither%20had%20I/another%20unremarkable%20stranger,%20quite%20a%20ways%20down%20the%20concourse,%20who%20caught%20it%20with%20a%20degree%20of%20coordination%20that%20most%20would%20have%20overlooked.%20It%20did%20not%20escape%20my%20notice,%20however.%20"Cousin,"%20I%20said,%20enough%20to%20convey%20-%20unless%20our%20visitor%20were%20quite%20ignorant,%20but,%20of%20course,%20at%20this%20point%20I%20was%20certain%20that%20she%20couldn't%20be%20-%20both%20that%20I%20knew%20what%20she%20was%20not%20and%20that%20I%20was%20giving%20her%20the%20benefit%20of%20the%20doubt%20as%20to%20what,%20or%20who,%20she%20was)! However, as a policy we will not include such entries in the database.
|
||||||
|
|
||||||
|
|
||||||
|
## FAQ
|
||||||
|
|
||||||
|
### Can we translate pronoun.is into another language?
|
||||||
|
|
||||||
|
I'd love to see pronoun.is-like apps exist in the world for other languages.
|
||||||
|
I'll answer any questions you need answered if you decide to fork the code to
|
||||||
|
create a similar site for a different language, and I'll also entertain the
|
||||||
|
idea of patching the pronoun.is codebase to support rending pages in different
|
||||||
|
languages as long as it doesn't make the code substantially more complicated.
|
||||||
|
|
||||||
|
Even if we add I18N support to the code, other language versions of the site
|
||||||
|
should have their own domains names (ideally with clever TLD puns like
|
||||||
|
pronoun.is has for english!)
|
||||||
|
|
||||||
|
(This was discussed in issues #13, #14, and #66)
|
||||||
|
|
||||||
|
### Can we change the example sentences?
|
||||||
|
|
||||||
|
Probably not, sorry, I really like these ones! Maybe in the future we can add
|
||||||
|
multiple different example sentence sets, though.
|
||||||
|
|
||||||
|
### Can we add pronunciation guides?
|
||||||
|
|
||||||
|
The short answer is, this is very hard! I'd love to have them if someone can
|
||||||
|
come up with a design for how to do this that'd work (including the logistics
|
||||||
|
of hosting media files and stuff).
|
||||||
|
|
||||||
|
(This was discussed in issues #43 and #80)
|
||||||
|
|
||||||
|
### Can we add pluralization support (i.e. themself vs themselves)
|
||||||
|
|
||||||
|
All of the ways I can think of to do this are pretty ugly (both visually
|
||||||
|
and in the code) so I'm pretty reluctant to do it. That's not an absolute no,
|
||||||
|
but any proposed solution would need to keep the pronouns database simple
|
||||||
|
enough that non-programmers can edit it and keep the URLs short, pretty, and
|
||||||
|
readable to humans as a sentence if you take all the punctuation out.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
Copyright © 2014-2018 Morgan Astra <m@morganastra.me>
|
Copyright © 2014-2018 Morgan Astra <m@morganastra.me>
|
||||||
|
|
||||||
|
18
resources/log4j.xml
Normal file
18
resources/log4j.xml
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||||||
|
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
|
||||||
|
<log4j:configuration debug="true"
|
||||||
|
xmlns:log4j='http://jakarta.apache.org/log4j/'>
|
||||||
|
|
||||||
|
<appender name="console" class="org.apache.log4j.ConsoleAppender">
|
||||||
|
<layout class="org.apache.log4j.PatternLayout">
|
||||||
|
<param name="ConversionPattern"
|
||||||
|
value="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n" />
|
||||||
|
</layout>
|
||||||
|
</appender>
|
||||||
|
|
||||||
|
<root>
|
||||||
|
<level value="INFO" />
|
||||||
|
<appender-ref ref="console" />
|
||||||
|
</root>
|
||||||
|
</log4j:configuration>
|
||||||
|
|
@ -111,7 +111,7 @@
|
|||||||
(href "https://www.gnu.org/licenses/agpl.html" "AGPLv3")
|
(href "https://www.gnu.org/licenses/agpl.html" "AGPLv3")
|
||||||
"! visit the project on "
|
"! visit the project on "
|
||||||
(href "https://github.com/witch-house/pronoun.is" "github")]
|
(href "https://github.com/witch-house/pronoun.is" "github")]
|
||||||
[:p "<3"]]))
|
[:p "<3"]]))
|
||||||
|
|
||||||
(defn footer-block []
|
(defn footer-block []
|
||||||
[:footer (usage-block) (contact-block)])
|
[:footer (usage-block) (contact-block)])
|
||||||
@ -126,6 +126,7 @@
|
|||||||
[:head
|
[:head
|
||||||
[:title title]
|
[:title title]
|
||||||
[:meta {:name "viewport" :content "width=device-width"}]
|
[:meta {:name "viewport" :content "width=device-width"}]
|
||||||
|
[:meta {:charset "utf-8"}]
|
||||||
[:meta {:name "description" :content (u/strip-markup examples)}]
|
[:meta {:name "description" :content (u/strip-markup examples)}]
|
||||||
[:meta {:name "twitter:card" :content "summary"}]
|
[:meta {:name "twitter:card" :content "summary"}]
|
||||||
[:meta {:name "twitter:title" :content title}]
|
[:meta {:name "twitter:title" :content title}]
|
||||||
@ -158,12 +159,18 @@
|
|||||||
(defn front []
|
(defn front []
|
||||||
(let [abbreviations (take 6 (u/abbreviate @pronouns-table))
|
(let [abbreviations (take 6 (u/abbreviate @pronouns-table))
|
||||||
links (map make-link abbreviations)
|
links (map make-link abbreviations)
|
||||||
title "Pronoun Island"]
|
title "Pronoun Island"
|
||||||
|
description "Pronoun.is is a website for personal pronoun usage examples."]
|
||||||
(html
|
(html
|
||||||
[:html
|
[:html
|
||||||
[:head
|
[:head
|
||||||
[:title title]
|
[:title title]
|
||||||
|
[:meta {:name "description" :content description}]
|
||||||
|
[:meta {:name "twitter:card" :content "summary"}]
|
||||||
|
[:meta {:name "twitter:title" :content title}]
|
||||||
|
[:meta {:name "twitter:description" :content description}]
|
||||||
[:meta {:name "viewport" :content "width=device-width"}]
|
[:meta {:name "viewport" :content "width=device-width"}]
|
||||||
|
[:meta {:charset "utf-8"}]
|
||||||
[:link {:rel "stylesheet" :href "/pronouns.css"}]]
|
[:link {:rel "stylesheet" :href "/pronouns.css"}]]
|
||||||
[:body
|
[:body
|
||||||
(header-block title)
|
(header-block title)
|
||||||
@ -183,6 +190,7 @@
|
|||||||
[:head
|
[:head
|
||||||
[:title title]
|
[:title title]
|
||||||
[:meta {:name "viewport" :content "width=device-width"}]
|
[:meta {:name "viewport" :content "width=device-width"}]
|
||||||
|
[:meta {:charset "utf-8"}]
|
||||||
[:link {:rel "stylesheet" :href "/pronouns.css"}]]
|
[:link {:rel "stylesheet" :href "/pronouns.css"}]]
|
||||||
[:body
|
[:body
|
||||||
(header-block title)
|
(header-block title)
|
||||||
@ -199,6 +207,7 @@
|
|||||||
[:head
|
[:head
|
||||||
[:title title]
|
[:title title]
|
||||||
[:meta {:name "viewport" :content "width=device-width"}]
|
[:meta {:name "viewport" :content "width=device-width"}]
|
||||||
|
[:meta {:charset "utf-8"}]
|
||||||
[:link {:rel "stylesheet" :href "/pronouns.css"}]]
|
[:link {:rel "stylesheet" :href "/pronouns.css"}]]
|
||||||
[:body
|
[:body
|
||||||
(header-block title)
|
(header-block title)
|
||||||
|
Loading…
Reference in New Issue
Block a user