git.iko.soy/typeable/inflections-hs
on master help sign in
Merge pull request #65 from stackbuilders/dc/standardize-docs
33d678eDaniel Calle
LICENSE+17−18
compare with master
unifiedsplit
@@ -1,22 +1,21 @@
1−Copyright (c) 2014-2016 Justin Leitgeb
2−
3MIT License
1MIT License
4
2
3+Copyright (c) 2022 Stack Builders Inc.
4+
5−Permission is hereby granted, free of charge, to any person obtaining
5+Permission is hereby granted, free of charge, to any person obtaining a copy
6−a copy of this software and associated documentation files (the
6+of this software and associated documentation files (the "Software"), to deal
7−"Software"), to deal in the Software without restriction, including
7+in the Software without restriction, including without limitation the rights
8−without limitation the rights to use, copy, modify, merge, publish,
9−distribute, sublicense, and/or sell copies of the Software, and to
8+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10−permit persons to whom the Software is furnished to do so, subject to
9+copies of the Software, and to permit persons to whom the Software is
11−the following conditions:
10+furnished to do so, subject to the following conditions:
12
11
13−The above copyright notice and this permission notice shall be
12+The above copyright notice and this permission notice shall be included in all
14−included in all copies or substantial portions of the Software.
13+copies or substantial portions of the Software.
15
14
16−THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17−EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18−MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19−NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20−LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
18+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21−OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
19+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22−WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
20+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+SOFTWARE.
README.md+11−8
@@ -49,11 +49,10 @@ If you want to specify a custom default replacement or approximation table for
49the `transliterate` function, you should instead call the `transliterateCustom`
49the `transliterate` function, you should instead call the `transliterateCustom`
50function which accepts a String for replacements and a Map for substitution.
50function which accepts a String for replacements and a Map for substitution.
51
51
52−## TODO
52+## Future work
53
53
54−I'd like this library to implement other functions found in the Rails
54+Ideally, we want to implement other functions found in the Rails
55−inflections library. If you need one of those functions, please submit a pull
55+inflections library. If you need one of those functions, please submit a pull request!
56−request!
57
56
58## Further documentation
57## Further documentation
59
58
@@ -64,10 +63,14 @@ For more information, please see the the
64
63
65Justin Leitgeb <justin@stackbuilders.com>
64Justin Leitgeb <justin@stackbuilders.com>
66
65
67−## Contributing
66+## License
68
67
69−You may submit pull requests to this repository on GitHub. Tests are appreciated with your contribution.
68+MIT, see [the LICENSE file](LICENSE).
70
69
71−## License
70+## Contributing
71+
72+Do you want to contribute to this project? Please take a look at our [contributing guideline](/docs/CONTRIBUTING.md) to know how you can help us build it.
72
73
73−MIT - see [the LICENSE file](LICENSE).
74+---
75+<img src="https://www.stackbuilders.com/media/images/Sb-supports.original.png" alt="Stack Builders" width="50%"></img>
76+[Check out our libraries](https://github.com/stackbuilders/) | [Join our team](https://www.stackbuilders.com/join-us/)
docs/CODE_OF_CONDUCT.mdnew file+35
@@ -0,0 +1,35 @@
1+# Code of conduct
2+
3+## Purpose
4+The primary goal of this Code of Conduct is to enable an open and welcoming environment. We pledge to making participation in our project a harassment-free experience for everyone, regardless of gender, sexual
5+orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof).
6+
7+## General recommendations
8+Examples of behavior that contributes to creating a positive environment include:
9+
10+- Using welcoming and inclusive language
11+- Being respectful of differing viewpoints and experiences
12+- Gracefully accepting constructive criticism
13+- Focusing on what is best for the community
14+- Showing empathy towards other community members
15+
16+Examples of unacceptable behavior by participants include:
17+
18+- The use of sexualized language or imagery and unwelcome sexual attention or advances
19+- Trolling, insulting/derogatory comments, and personal or political attacks
20+- Public or private harassment
21+- Publishing others' private information, such as a physical or electronic address, without explicit permission
22+- Other conduct which could reasonably be considered inappropriate in a professional setting
23+
24+## Maintainer responsibilities
25+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.
26+
27+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.
28+
29+## Scope
30+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.
31+
32+## Enforcement
33+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [community@stackbuilders.com](mailto:community@stackbuilders.com). 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.
34+
35+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.
docs/CONTRIBUTING.mdnew file+13
@@ -0,0 +1,13 @@
1+
2+Thank you for your interest in contributing to this Stack Builders' library. To contribute, please take our [Code of Conduct](CODE_OF_CONDUCT.md) into account, along with the following recommendations:
3+
4+- When submitting contributions to this repository, please make sure to discuss with the maintainer(s) the change you want to make. You can do this through an issue, or by sending an email to [community@stackbuilders.com](mailto:community@stackbuilders.com)
5+
6+- Once the change has been discussed with the maintainer(s), feel free to open a Pull Request. Please include a link to the issue you're trying to solve, or a quick summary of the discussed changes.
7+
8+- If adding any new features that you think should be considered in the README file, please add that information in your Pull Request.
9+
10+- Once you get an approval from any of the maintainers, please merge your Pull Request. Keep in mind that some of our Stack Builders repositories use CI/CD pipelines, so you will need to pass all of the required checks before merging.
11+
12+## Getting help
13+Contact any of our current maintainers, or send us an email at [community@stackbuilders.com](mailto:community@stackbuilders.com) for more information. Thank you for contributing!