Skip to content

Commit 98be49b

Browse files
committed
Enhance project's community profile
Add a CONTRIBUTING file together with a Code of Conduct and templates for issues and pull requests.
1 parent 152ee94 commit 98be49b

5 files changed

+170
-4
lines changed

CODE_OF_CONDUCT.md

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
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 make participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and
9+
expression, level of experience, education, socio-economic status, nationality,
10+
personal appearance, race, religion, or sexual identity and 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 within all project spaces, and it also applies when
49+
an individual is representing the project or its community in public spaces.
50+
Examples of representing a project or community include using an official
51+
project e-mail address, posting via an official social media account, or acting
52+
as an appointed representative at an online or offline event. Representation of
53+
a project may be 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 [email protected]. 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
62+
incident. Further details of specific enforcement policies may be posted
63+
separately.
64+
65+
Project maintainers who do not follow or enforce the Code of Conduct in good
66+
faith may face temporary or permanent repercussions as determined by other
67+
members of the project's leadership.
68+
69+
## Attribution
70+
71+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
72+
version 1.4, available at
73+
<https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
74+
75+
[homepage]: https://www.contributor-covenant.org
76+
77+
For answers to common questions about this code of conduct, see
78+
<https://www.contributor-covenant.org/faq>

CONTRIBUTING.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
Contributing to ExifReader
2+
==========================
3+
4+
If you want to contribute in any way, I'll be very happy to receive that help
5+
making this project better. There are several ways to contribute and all are
6+
welcome. You can send in suggestions for better documentation, new
7+
functionality, or a bug-fix (just create an issue). Or you can create a pull
8+
request for the thing you want changed or added.
9+
10+
Please note that this project is released with a
11+
[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this
12+
project you agree to abide by its terms.
13+
14+
Creating an issue
15+
-----------------
16+
17+
I will appreciate everything from pointing out spelling errors to a huge
18+
functionality suggestion. Just put in enough information for me to understand
19+
the issue. For reporting bugs specifically, please include the following if
20+
possible:
21+
22+
- A description of the issue and how to reproduce according to the issue
23+
template.
24+
- An example JPEG image where the problem can be seen. This is very valuable.
25+
26+
Creating a pull request
27+
-----------------------
28+
29+
If the pull request has code changes, they should follow the ESLint rules and be
30+
covered by unit tests. Running the linter and the tests is easy after
31+
`npm install` has been run:
32+
33+
```bash
34+
npm run lint
35+
npm test
36+
```
37+
38+
If you need help with writing tests, just ask. I can probably help in one way or
39+
another.
40+
41+
The commit message should be descriptive and (if needed) have an explanatory
42+
body. This is one of all the guides out there on how to write good messages:
43+
[How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/)
44+
45+
In short, here are some guidelines:
46+
47+
- Write the subject line in imperative mood: `Add IPTC support for records 1
48+
and 7`, not `Added...`, `Fixing...`, etc.
49+
- Try to not use more than 50 characters in the subject line with 72 as a hard
50+
limit (otherwise it will get truncated).
51+
- For non-trivial changes, add a body to explain what was changed and why.
52+
- Wrap the lines of the body at 72 characters.

ISSUE_TEMPLATE.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
### Description
2+
3+
<!-- Describe what you're suggesting, the bug you've found, etc. -->
4+
5+
<!-- If you found a bug, fill in the details below. Otherwise delete it. -->
6+
7+
**How to reproduce**
8+
9+
1. <!-- First step -->
10+
2. <!-- Second step -->
11+
3. <!-- And so on -->
12+
13+
**What I expected would happen:**
14+
15+
<!-- The behavior you expected. -->
16+
17+
**What really happened:**
18+
19+
<!-- What you actually saw. -->

PULL_REQUEST_TEMPLATE.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
### Description
2+
3+
<!-- Describe what the change does and why it's needed. If it's related to an issue, link to it. -->

README.md

+18-4
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,9 @@ directory.
124124
Tips
125125
----
126126

127-
- After parsing the tags, consider deleting the MakerNote tag if you know you will load a lot of files and storing the tags. It can be really large for some manufacturers. See the examples folder to see how you can do that.
127+
- After parsing the tags, consider deleting the MakerNote tag if you know you
128+
will load a lot of files and storing the tags. It can be really large for
129+
some manufacturers. See the examples folder to see how you can do that.
128130

129131
Testing
130132
-------
@@ -136,11 +138,23 @@ Testing is done with [Mocha](https://mochajs.org/) and
136138
npm test
137139
```
138140

139-
Issues
140-
------
141+
Known Issues
142+
------------
143+
144+
- The descriptions for UserComment, GPSProcessingMethod and GPSAreaInformation
145+
are missing for other encodings than ASCII.
146+
147+
Contributing
148+
------------
149+
150+
See [CONTRIBUTE.md](CONTRIBUTE.md).
141151

142-
- The descriptions for UserComment, GPSProcessingMethod and GPSAreaInformation are missing for other encodings than ASCII.
152+
Code of Conduct
153+
---------------
143154

155+
This project is released with a
156+
[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this
157+
project you agree to abide by its terms.
144158

145159
License
146160
-------

0 commit comments

Comments
 (0)