Skip to content

Commit 60d0cb8

Browse files
committedOct 15, 2018
chore: github md files
1 parent 1829184 commit 60d0cb8

File tree

4 files changed

+153
-0
lines changed

4 files changed

+153
-0
lines changed
 

‎.github/ISSUE_TEMPLATE/bug-report.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help improve openid-client
4+
5+
---
6+
7+
**Describe the bug**
8+
<!-- A clear and concise description of what the bug is. -->
9+
10+
11+
**To Reproduce**
12+
Issuer and Client configuration: (inline or gist) - Don't forget to redact your secrets.
13+
```js
14+
// Issuer configuration (issuer.metadata) and how it's constructed (discovery or manual?)
15+
{
16+
// ...
17+
}
18+
// Client configuration (client.metadata) and how it's constructed (fromUri or manual?)
19+
{
20+
// ...
21+
}
22+
```
23+
24+
Steps to reproduce the behaviour:
25+
26+
1.
27+
2.
28+
3.
29+
30+
**Expected behaviour**
31+
A clear and concise description of what you expected to happen.
32+
33+
**Environment:**
34+
- openid-client version: [e.g. v2.4.3]
35+
- node version: [e.g. v8.9.0]
36+
37+
**Additional context**
38+
Add any other context about the problem here.
39+
40+
- [ ] the bug is happening on latest openid-client too.
41+
- [ ] i have searched the issues tracker on github for similar issues and couldn't find anything related.
+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Feature request
3+
about: Suggest a feature for openid-client
4+
5+
---
6+
7+
**Is your feature request related to a problem? Please describe.**
8+
A clear and concise description of what the problem is.
9+
10+
**Describe the solution you'd like**
11+
A clear and concise description of what you want to happen.
12+
13+
**Describe alternatives you've considered**
14+
A clear and concise description of any alternative solutions or features you've considered.
15+
16+
**Additional context**
17+
Add any other context about the problem here.
18+
19+
- [ ] i have searched the issues tracker on github for similar requests and couldn't find anything related.

‎CODE_OF_CONDUCT.md

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

‎CONTRIBUTING.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributing to openid-client
2+
3+
Please note we have a [code of conduct][coc], please follow it in all your interactions with the
4+
project.
5+
6+
When contributing to this project, please first discuss the change you wish to make via issue,
7+
email, or any other method with the owners of this project before proposing a change via a Pull
8+
Request. Use (and follow!) the appropriate [Issue Template][new-issue] to do so. The project
9+
promotes and follows current best practices in regards to the specifications it implements.
10+
A contribution that tries to implement something non-standard will most likely be dismissed.
11+
12+
## Rules of the discussions
13+
14+
Remember to be very clear and transparent when discussing any issue in the discussions boards. We
15+
ask that you keep the language to English and keep on track with the issue at hand. Lastly, please
16+
be respectful of our fellow contributors and keep an exemplary level of professionalism at all
17+
times.
18+
19+
## Pull Request Checklist
20+
21+
- Follow the eslint rules
22+
- Do not modify the eslint rules
23+
- File names must be snake_case.js
24+
- Add tests covering 100% of the library code you are adding or modifying
25+
- Existing tests must pass
26+
- Unless previously agreed upon (i.e. fixing a bug) all contributions must be backwards compatible
27+
- Follow [standard-version][standard-version] commit guidelines
28+
29+
[coc]: https://github.com/panva/node-openid-client/blob/master/CODE_OF_CONDUCT.md
30+
[new-issue]: https://github.com/panva/node-openid-client/issues/new/choose
31+
[standard-version]: https://github.com/conventional-changelog/standard-version

0 commit comments

Comments
 (0)
Please sign in to comment.