Skip to content

Commit

Permalink
Open Source Repo Documents (#184)
Browse files Browse the repository at this point in the history
*  Add @mrbinky3000 as a contributor

*  Add @tim-steele as a contributor

*  Add @TheFullResolution as a contributor

*  Add @littlejustinh as a contributor

*  Add @NormySan as a contributor

*  Add @dylanpyle as a contributor

*  Add @maps82 as a contributor

*  Add @arnaudambro as a contributor

*  Add @chungwong as a contributor

*  Add @fdionisi as a contributor

*  Add @KubaJastrz as a contributor

*  Add @jpdelima as a contributor

*  Add @martinmckenna as a contributor

*  Add @perenstrom as a contributor

*  Add @serafinomb as a contributor

*  Add @killia15 as a contributor

*  Add @timc13 as a contributor

*  Add @zoeyzou as a contributor

*  Add @djshapiro as a contributor

* feat(oss): add templates and documents for open source

* fix: fix contributors merge conflict

* remove idea files
  • Loading branch information
bcarroll22 authored and tim-steele committed Oct 2, 2019
1 parent cd1f57a commit 3b58421
Show file tree
Hide file tree
Showing 7 changed files with 209 additions and 2 deletions.
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug_Report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
name: 🐛 Bug Report
about: I think something is broken 😡
---

<!--
* Please fill out this template with all the relevant information so we can understand what's going on and fix the issue. We appreciate bugs filed and PRs submitted!
* Please make sure that you are familiar with and follow the Code of Conduct for this project (found in the CODE_OF_CONDUCT.md file).
We'll probably ask you to submit the fix (after giving some direction). If you've never done that before, that's great! Check this free short video tutorial to learn how: http://kcd.im/pull-request
-->

- `pure-react-carousel` version:
- `react` version:
- `browser` used:
- `node` version:

### Relevant code or config:

```js
const your = code => 'here';
```

### What you did:

<!-- How did you come across this bug? -->

### What happened:

<!-- Please provide the full error message/screenshots/anything else that might help -->

### Reproduction:

<!-- If possible, please create a repository that reproduces the issue with the minimal amount of code possible.
### Problem description:
<!-- Please describe why the current behavior is a problem -->

### Suggested solution:

<!-- It's ok if you don't have a suggested solution, but it really helps if you could do a little digging to come up with some suggestion of how to improve things. -->

### Can you help us fix this issue by submitting a pull request?

<!-- We love contribution from users! If you know how this should be fixed, the project maintainers encourage you to submit a PR to fix the issue you're experiencing. If you submit a fix for an issue you've experienced, we'll happily add you to the Contributors list on the project readme! -->
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature_Request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: 💡 Feature Request
about: I think something could be better 🤔
---

<!--
* Please fill out this template with all the relevant information so we can understand what's going on and fix the issue. We appreciate bugs filed and PRs submitted!
* Please make sure that you are familiar with and follow the Code of Conduct for this project (found in the CODE_OF_CONDUCT.md file).
It'd be great if after the discussion you're the one who submits the PR that implements this feature. If you've never done that before, that's great! Check this free short video tutorial to learn how: http://kcd.im/pull-request
-->

**Describe the feature you'd like:**

<!-- A clear and concise description of what you want to happen. Add any considered drawbacks. -->

**Suggested implementation:**

<!-- Helpful but optional 😀 -->

**Describe alternatives you've considered:**

<!-- A clear and concise description of any alternative solutions or features you've considered. -->

**Teachability, Documentation, Adoption, Migration Strategy:**

<!-- If you can, explain how users will be able to use this and possibly write out a version of the docs. -->
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/Question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: ❓ Support Question
about: I think I don't understand how to do something 🤨
---

<!-- ---------- 👆 Click "Preview"! -->

Issues on GitHub are intended to be related to problems and feature requests so we ask you not use
issues to ask for support.

---

## ❓ Pure React Carousel Resources

- Tutorial - https://github.com/express-labs/pure-react-carousel#-tutorial
- Examples - https://express-labs.github.io/pure-react-carousel/
- Stack Overflow - https://stackoverflow.com/questions/tagged/pure-react-carousel

**ISSUES WHICH ARE QUESTIONS WILL BE CLOSED**
34 changes: 34 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<!--
Thanks for your interest in the project. Bugs filed and PRs submitted are appreciated!
Please make sure that you are familiar with and follow the Code of Conduct for this project (found in the CODE_OF_CONDUCT.md file).
Please fill out the information below to expedite the review and (hopefully) merge of your pull request!
-->

**What**:

<!-- What changes are being made? (What feature/bug is being fixed here?) -->

**Why**:

<!-- Why are these changes necessary? -->

**How**:

<!-- How were these changes implemented? -->

**Checklist**:

<!-- Have you done all of these things? -->
<!-- Add "(N/A)" to the end of each line that's irrelevant to your changes -->
<!-- to check an item, place an "x" in the box like so: "- [x] Documentation" -->

- [ ] Documentation added/updated
- [ ] Typescript definitions updated
- [ ] Tests added and passing
- [ ] Ready to be merged <!-- In your opinion -->

<!-- feel free to add additional comments -->
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# 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, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior 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 behavior 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
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

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 behaviors 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 behavior may be
reported by contacting the project team at brandonvcarroll@gmail.com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and 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.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2017 Matthew Toledo
Copyright (c) 2019 Express

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -666,4 +666,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

0 comments on commit 3b58421

Please sign in to comment.