Skip to content

Commit 93e1e3a

Browse files
committed
Update documentation to match our Markdown guidelines
1 parent bd7eb41 commit 93e1e3a

File tree

3 files changed

+152
-135
lines changed

3 files changed

+152
-135
lines changed

CONTRIBUTING.md

+34-33
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,33 @@
11
# Contributing
22

3-
When contributing to this repository, please first discuss the change you wish to make via issue,
4-
email, or any other method with the owners of this repository before making a change.
3+
When contributing to this repository, please first discuss the change you wish
4+
to make via issue, email, or any other method with the owners of this repository
5+
before making a change.
56

6-
Please note we have a code of conduct, please follow it in all your interactions with the project.
7+
Please note we have a code of conduct, please follow it in all your interactions
8+
with the project.
79

8-
## Found an issue? Want a Feature?
9-
10-
You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by submitting an issue to our [GitHub Repository]. Before you create an issue, make sure you search the archive, maybe your question was already answered.
10+
## Issues and feature requests
1111

12+
You've found a bug in the source code, a mistake in the documentation or maybe
13+
you'd like a new feature? You can help us by submitting an issue to our
14+
[GitHub Repository][github]. Before you create an issue, make sure you search
15+
the archive, maybe your question was already answered.
1216

1317
Even better: You could submit a pull request with a fix / new feature!
1418

15-
[GitHub Repository]: https://github.com/dealerdirect/php-qa-tools/issues
16-
17-
## Pull Request Process
19+
## Pull request process
1820

19-
1. Search our repository for open or closed [Pull Requests] that relates to your submission.
20-
You don't want to duplicate effort.
21-
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
22-
do not have permission to do that, you may request the second reviewer to merge it for you.
21+
1. Search our repository for open or closed [pull requests][prs] that relates
22+
to your submission. You don't want to duplicate effort.
2323

24-
[Pull Requests]: https://github.com/dealerdirect/php-qa-tools/pulls
24+
2. You may merge the pull request in once you have the sign-off of two other
25+
developers, or if you do not have permission to do that, you may request
26+
the second reviewer to merge it for you.
2527

26-
## Code of Conduct
28+
## Code of conduct
2729

28-
### Our Pledge
30+
### Our pledge
2931

3032
In the interest of fostering an open and welcoming environment, we as
3133
contributors and maintainers pledge to making participation in our project and
@@ -34,29 +36,26 @@ size, disability, ethnicity, gender identity and expression, level of experience
3436
nationality, personal appearance, race, religion, or sexual identity and
3537
orientation.
3638

37-
### Our Standards
39+
### Our standards
3840

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

42-
* Using welcoming and inclusive language
43-
* Being respectful of differing viewpoints and experiences
44-
* Gracefully accepting constructive criticism
45-
* Focusing on what is best for the community
46-
* Showing empathy towards other community members
44+
- Using welcoming and inclusive language
45+
- Being respectful of differing viewpoints and experiences
46+
- Gracefully accepting constructive criticism
47+
- Focusing on what is best for the community
48+
- Showing empathy towards other community members
4749

4850
Examples of unacceptable behavior by participants include:
4951

50-
* The use of sexualized language or imagery and unwelcome sexual attention or
51-
advances
52-
* Trolling, insulting/derogatory comments, and personal or political attacks
53-
* Public or private harassment
54-
* Publishing others' private information, such as a physical or electronic
55-
address, without explicit permission
56-
* Other conduct which could reasonably be considered inappropriate in a
57-
professional setting
52+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
53+
- Trolling, insulting/derogatory comments, and personal or political attacks
54+
- Public or private harassment
55+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
56+
- Other conduct which could reasonably be considered inappropriate in a professional setting
5857

59-
### Our Responsibilities
58+
### Our responsibilities
6059

6160
Project maintainers are responsible for clarifying the standards of acceptable
6261
behavior and are expected to take appropriate and fair corrective action in
@@ -92,8 +91,10 @@ members of the project's leadership.
9291

9392
### Attribution
9493

95-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
96-
available at [http://contributor-covenant.org/version/1/4][version]
94+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
95+
version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
9796

9897
[homepage]: http://contributor-covenant.org
9998
[version]: http://contributor-covenant.org/version/1/4/
99+
[github]: https://github.com/dealerdirect/php-qa-tools/issues
100+
[prs]: https://github.com/dealerdirect/php-qa-tools/pulls

LICENSE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2016 Dealerdirect B.V.
3+
Copyright (c) 2016-2017 Dealerdirect B.V.
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)