Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of github.com:vardius/peer-cdn
- Loading branch information
Showing
3 changed files
with
152 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# 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 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 vardius@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. | ||
|
||
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 [http://contributor-covenant.org/version/1/4][version] | ||
|
||
[homepage]: http://contributor-covenant.org | ||
[version]: http://contributor-covenant.org/version/1/4/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
# Contributing | ||
|
||
We are open to, and grateful for, any contributions made by the community. By contributing to **peer-cdn**, you agree to abide by the [code of conduct](https://github.com/vardius/peer-cdn/blob/master/CODE_OF_CONDUCT.md). | ||
|
||
## Reporting Issues and Asking Questions | ||
|
||
Before opening an issue, please search the [issue tracker](https://github.com/vardius/peer-cdn/issues) to make sure your issue hasn't already been reported. | ||
|
||
### Bugs and Improvements | ||
|
||
We use the issue tracker to keep track of bugs and improvements to **peer-cdn** itself, its examples, and the documentation. We encourage you to open issues to discuss improvements, architecture, theory, internal implementation, etc. If a topic has been discussed before, we will ask you to join the previous discussion. | ||
|
||
Any pull requests that involve breaking changes should be made against the `next` branch. | ||
|
||
### Getting Help | ||
|
||
For support or usage questions like “how do I do X with **peer-cdn**” and “my code doesn't work”, we encourage you to post an issue. | ||
|
||
Please be considerate when doing this as this is not the primary purpose of the issue tracker. | ||
|
||
### Help Us Help You | ||
|
||
It is a good idea to structure your code and question in a way that is easy to read to entice people to answer it. For example, we encourage you to use syntax highlighting, indentation, and split text in paragraphs. | ||
|
||
Please keep in mind that people spend their free time trying to help you. You can make it easier for them if you provide versions of the relevant libraries and a runnable small project reproducing your issue. You can put your code on [JSBin](http://jsbin.com) or, for bigger projects, on GitHub. Make sure all the necessary dependencies are declared in `package.json` so anyone can run `npm install && npm start` and reproduce your issue. | ||
|
||
## Development | ||
|
||
Visit the [issue tracker](https://github.com/vardius/peer-cdn/issues) to find a list of open issues that need attention. | ||
|
||
Fork, then clone the repo: | ||
|
||
``` | ||
git clone https://github.com/your-username/peer-cdn.git | ||
``` | ||
|
||
### Building | ||
|
||
#### Building Redux | ||
|
||
Running the `build` task will create all a CommonJS module-per-module build, a UMD build and ES6 build. | ||
``` | ||
npm run build | ||
``` | ||
|
||
### Testing and Linting | ||
|
||
To only run linting: | ||
|
||
``` | ||
npm run lint | ||
``` | ||
|
||
To only run tests: | ||
|
||
``` | ||
npm run test | ||
``` | ||
|
||
To continuously watch and run tests, run the following: | ||
|
||
``` | ||
npm run test:watch | ||
``` | ||
|
||
### Docs | ||
|
||
Improvements to the documentation are always welcome. In the docs we abide by typographic rules, so instead of ' you should use '. Same goes for “ ” and dashes (—) where appropriate. These rules only apply to the text, not to code blocks. | ||
|
||
### Sending a Pull Request | ||
|
||
For non-trivial changes, please open an issue with a proposal for a new feature or refactoring before starting on the work. We don't want you to waste your efforts on a pull request that we won't want to accept. | ||
|
||
On the other hand, sometimes the best way to start a conversation *is* to send a pull request. Use your best judgement! | ||
|
||
In general, the contribution workflow looks like this: | ||
|
||
* Open a new issue in the [Issue tracker](https://github.com/vardius/peer-cdn/issues). | ||
* Fork the repo. | ||
* Create a new feature branch based off the `master` branch. | ||
* Make sure all tests pass and there are no linting errors. | ||
* Submit a pull request, referencing any issues it addresses. | ||
|
||
Please try to keep your pull request focused in scope and avoid including unrelated commits. | ||
|
||
After you have submitted your pull request, we'll try to get back to you as soon as possible. We may suggest some changes or improvements. | ||
|
||
Thank you for contributing! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
**Do you want to request a *feature* or report a *bug*?** | ||
|
||
|
||
|
||
**What is the current behavior?** | ||
|
||
|
||
|
||
**If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem via https://jsfiddle.net or similar.** | ||
|
||
|
||
|
||
**What is the expected behavior?** | ||
|
||
|
||
|
||
**Which versions of **peer-cdn**, and which browser and OS are affected by this issue? Did this work in previous versions?** | ||
|