mirror of
https://github.com/hanzoai/openid-client.git
synced 2026-09-24 17:01:10 +00:00
chore: github md files
This commit is contained in:
@@ -0,0 +1,41 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help improve openid-client
|
||||
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
<!-- A clear and concise description of what the bug is. -->
|
||||
|
||||
|
||||
**To Reproduce**
|
||||
Issuer and Client configuration: (inline or gist) - Don't forget to redact your secrets.
|
||||
```js
|
||||
// Issuer configuration (issuer.metadata) and how it's constructed (discovery or manual?)
|
||||
{
|
||||
// ...
|
||||
}
|
||||
// Client configuration (client.metadata) and how it's constructed (fromUri or manual?)
|
||||
{
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
Steps to reproduce the behaviour:
|
||||
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
**Expected behaviour**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Environment:**
|
||||
- openid-client version: [e.g. v2.4.3]
|
||||
- node version: [e.g. v8.9.0]
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
|
||||
- [ ] the bug is happening on latest openid-client too.
|
||||
- [ ] i have searched the issues tracker on github for similar issues and couldn't find anything related.
|
||||
@@ -0,0 +1,19 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest a feature for openid-client
|
||||
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is.
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
|
||||
- [ ] i have searched the issues tracker on github for similar requests and couldn't find anything related.
|
||||
@@ -0,0 +1,62 @@
|
||||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers
|
||||
pledge to making participation in our project and our community a harassment-free experience for
|
||||
everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level
|
||||
of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behaviour that contributes to creating a positive environment include:
|
||||
|
||||
* Using welcoming and inclusive language
|
||||
* Being respectful of differing viewpoints and experiences
|
||||
* Gracefully accepting constructive criticism
|
||||
* Focusing on what is best for the community
|
||||
* Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behaviour by participants include:
|
||||
|
||||
* The use of sexualized language or imagery and unwelcome sexual attention or advances
|
||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or electronic address, without explicit
|
||||
permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a professional setting
|
||||
|
||||
## Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable behaviour and are
|
||||
expected to take appropriate and fair corrective action in response to any instances of unacceptable
|
||||
behaviour.
|
||||
|
||||
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 behaviours that they deem inappropriate,
|
||||
threatening, offensive, or harmful.
|
||||
|
||||
## Scope
|
||||
|
||||
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.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported by contacting
|
||||
the project team at panva.ip@gmail.com. The project team will review and investigate all complaints,
|
||||
and will respond in a way that it deems 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.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at
|
||||
[http://contributor-covenant.org/version/1/4][version]
|
||||
|
||||
[homepage]: http://contributor-covenant.org
|
||||
[version]: http://contributor-covenant.org/version/1/4/
|
||||
@@ -0,0 +1,31 @@
|
||||
# Contributing to openid-client
|
||||
|
||||
Please note we have a [code of conduct][coc], please follow it in all your interactions with the
|
||||
project.
|
||||
|
||||
When contributing to this project, please first discuss the change you wish to make via issue,
|
||||
email, or any other method with the owners of this project before proposing a change via a Pull
|
||||
Request. Use (and follow!) the appropriate [Issue Template][new-issue] to do so. The project
|
||||
promotes and follows current best practices in regards to the specifications it implements.
|
||||
A contribution that tries to implement something non-standard will most likely be dismissed.
|
||||
|
||||
## Rules of the discussions
|
||||
|
||||
Remember to be very clear and transparent when discussing any issue in the discussions boards. We
|
||||
ask that you keep the language to English and keep on track with the issue at hand. Lastly, please
|
||||
be respectful of our fellow contributors and keep an exemplary level of professionalism at all
|
||||
times.
|
||||
|
||||
## Pull Request Checklist
|
||||
|
||||
- Follow the eslint rules
|
||||
- Do not modify the eslint rules
|
||||
- File names must be snake_case.js
|
||||
- Add tests covering 100% of the library code you are adding or modifying
|
||||
- Existing tests must pass
|
||||
- Unless previously agreed upon (i.e. fixing a bug) all contributions must be backwards compatible
|
||||
- Follow [standard-version][standard-version] commit guidelines
|
||||
|
||||
[coc]: https://github.com/panva/node-openid-client/blob/master/CODE_OF_CONDUCT.md
|
||||
[new-issue]: https://github.com/panva/node-openid-client/issues/new/choose
|
||||
[standard-version]: https://github.com/conventional-changelog/standard-version
|
||||
Reference in New Issue
Block a user