Skip to content

Commit 4f83cc8

Browse files
committed
Added Code of Conduct (http://contributor-covenant.org/version/1/4/code_of_conduct.md) and a Contributing section in the README.
1 parent c361d09 commit 4f83cc8

2 files changed

Lines changed: 102 additions & 0 deletions

File tree

CODE OF CONDUCT.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at git (U+0040 COMMERCIAL AT) boredzo.org. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,34 @@ I use [Rick McCarty's algorithm for converting calendar dates to week dates](htt
173173

174174
* There is no method to analyze a date string and tell you what was found in it (year, month, week, day, ordinal day, etc.). Feel free to submit a patch.
175175

176+
## Contributing
177+
178+
This project adheres to [the Contributor Covenant, version 1.4](CODE OF CONDUCT.md). Please read that before deciding whether you are willing to contribute.
179+
180+
You're welcome to work on any open bug in the issue tracker, but we do have some that are [up-for-grabs](https://github.com/boredzo/iso-8601-date-formatter/issues?q=is%3Aissue+is%3Aopen+label%3Aup-for-grabs) that are particularly easy or potentially interesting.
181+
182+
Please don't break compatibility with old OS versions (OS X 10.7/iOS 4) until work begins on the 1.0 release. That won't happen until 0.9 is done, and starting 1.0-only work (e.g., ARCification) early will lead to conflicts.
183+
184+
The tests use ARC, but the formatter itself does not ([yet](https://github.com/boredzo/iso-8601-date-formatter/issues/21)). Please be sure to add the needed `release` or `autorelease` messages when adding code that creates objects.
185+
186+
Adding test cases is highly encouraged, especially if adding new functionality. Ideally, please test a comprehensive set of:
187+
188+
- success cases
189+
- failure cases
190+
- exception (programmer error) cases: even if something isn't supported, the behavior should still be reliable and preferably diagnostically helpful
191+
192+
Travis CI will run the tests automatically when you submit a pull request, and a PR with failing tests will not be accepted.
193+
194+
Contributions consisting of nothing but test cases are welcome. If one/some of those cases fail, please include fixes, or at least, submit an issue report for the failure(s) and surround the failing tests with:
195+
196+
#if FIXED_(issue number)
197+
- (void) test_thingThatDoesntWorkButShould {
198+
199+
}
200+
#endif FIXED_(issue number)
201+
202+
As far as code style, mostly, please try to remain consistent with the existing code. Please do add nullability annotations (`ISO8601_NULLABLE`/`ISO8601_NONNULL`) and `const` to new code whenever applicable.
203+
176204
## Copyright
177205

178206
This code is copyright 2006–2016 Peter Hosey. It is under the BSD license; see LICENSE.txt for the full text of the license.

0 commit comments

Comments
 (0)