Skip to content

Commit 2fa6209

Browse files
committed
first crack at getting an awesome repo up
1 parent 9e010f6 commit 2fa6209

5 files changed

+407
-2
lines changed

.github/contributing.md

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Contributing to Feathers
2+
3+
Thank you for contributing to Feathers! :heart: :tada:
4+
5+
Feathers embraces modularity and is broken up across many repos. To make this easier to manage we currently use Github projects for issue triage and visibility. To get a high level view of the core releases you can go to https://github.com/feathersjs/feathers/projects.
6+
7+
## Report a bug
8+
9+
Before creating an issue please make sure you have checked out the docs, specifically the [FAQ](https://docs.feathersjs.com/help/faq.html) section. You might want to also try searching Github. It's pretty likely someone has already asked a similar question.
10+
11+
If you haven't found your answer please feel free to join our [slack channel](http://slack.feathersjs.com), create an issue on Github, or post on [Stackoverflow](http://stackoverflow.com) using the `feathers` or `feathersjs` tag. We try our best to monitor Stackoverflow but you're likely to get more immediate responses in Slack and Github.
12+
13+
Issues can be reported in the [issue tracker](https://github.com/feathersjs/feathers/issues). Since feathers combines many modules it can be hard for us to assess the root cause without knowing which modules are being used and what your configuration looks like, so **it helps us immensely if you can link to a simple example that reproduces your issue**.
14+
15+
## Report a Security Concern
16+
17+
We take security very seriously at Feathers. We welcome any peer review of our 100% open source code to ensure nobody's Feathers app is ever compromised or hacked. As a web application developer you are responsible for any security breaches. We do our very best to make sure Feathers is as secure as possible by default.
18+
19+
In order to give the community time to respond and upgrade we strongly urge you report all security issues to us. Send one of the core team members a PM in [Slack](http://slack.feathersjs.com) or email us at <a href="mailto:">[email protected]</a> with details and we will respond ASAP.
20+
21+
For full details refer to our [Security docs](https://docs.feathersjs.com/SECURITY.html).
22+
23+
## Pull Requests
24+
25+
We :heart: pull requests and we're continually working to make it as easy as possible for people to contribute, including a [Plugin Generator](https://github.com/feathersjs/generator-feathers-plugin) and a [common test suite](https://github.com/feathersjs/feathers-service-tests) for database adapters.
26+
27+
We prefer small pull requests with minimal code changes. The smaller they are the easier they are to review and merge. A FeathersJS maintainer will pick up your PR and review it as soon as they can. They may ask for changes or reject your pull request. This is not a reflection of you as an engineer or a person. Please accept feedback graciously as we will also try to be sensitive when providing it.
28+
29+
Although we generally accept many PRs they can be rejected for many reasons. We will be as transparent as possible but it may simply be that you do not have the same context, historical knowledge or information regarding the roadmap that the maintainers have. We value the time you take to put together any contributions so we pledge to always be respectful of that time and will try to be as open as possible so that you don't waste it. :smile:
30+
31+
**All PRs (except documentation) should be accompanied with tests and pass the linting rules.**
32+
33+
### Code style
34+
35+
Before running the tests from the `test/` folder `npm test` will run ESlint. You can check your code changes individually by running `npm run lint`.
36+
37+
### Tests
38+
39+
[Mocha](http://mochajs.org/) tests are located in the `test/` folder and can be run using the `npm run mocha` or `npm test` (with ESLint and code coverage) command.
40+
41+
### Documentation
42+
43+
Feathers documentation is contained in Markdown files in the [feathers-docs](https://github.com/feathersjs/feathers-docs) repository. To change the documentation submit a pull request to that repo, referencing any other PR if applicable, and the docs will be updated with the next release.
44+
45+
## External Modules
46+
47+
If you're written something awesome for Feathers, the Feathers ecosystem, or using Feathers please add it to the [awesome-feathersjs](https://github.com/feathersjs-ecosystem/awesome-feathersjs). You also might want to check out the [Plugin Generator](https://github.com/feathersjs/generator-feathers-plugin) that can be used to scaffold plugins to be Feathers compliant from the start.
48+
49+
If you think it would be a good core `feathersjs` module or `featherjs-ecosystem` module then please contact one of the Feathers maintainers in [Slack](http://slack.feathersjs.com) and we can discuss whether it belongs and how to get it there. :beers:
50+
51+
## Contributor Code of Conduct
52+
53+
As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
54+
55+
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
56+
57+
Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
58+
59+
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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
62+
63+
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

.github/issue_template.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
### Steps to reproduce
2+
3+
(First please check that this issue is not already solved as [described
4+
here](https://github.com/feathersjs/feathers/blob/master/.github/contributing.md#report-a-bug))
5+
6+
- [ ] Tell us what broke. The more detailed the better.
7+
- [ ] If you can, please create a simple example that reproduces the issue and link to a gist, jsbin, repo, etc.
8+
9+
### Expected behavior
10+
Tell us what should happen
11+
12+
### Actual behavior
13+
Tell us what happens instead
14+
15+
### System configuration
16+
17+
Tell us about the applicable parts of your setup.
18+
19+
**Module versions** (especially the part that's not working):
20+
21+
**NodeJS version**:
22+
23+
**Operating System**:
24+
25+
**Browser Version**:
26+
27+
**React Native Version**:
28+
29+
**Module Loader**:

.github/pull_request_template.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
### Summary
2+
3+
(If you have not already please refer to the contributing guideline as [described
4+
here](https://github.com/feathersjs/feathers/blob/master/.github/contributing.md#pull-requests))
5+
6+
- [ ] Tell us about the problem your pull request is solving.
7+
- [ ] Are there any open issues that are related to this?
8+
- [ ] Is this PR dependent on PRs in other repos?
9+
10+
If so, please mention them to keep the conversations linked together.
11+
12+
### Other Information
13+
14+
If there's anything else that's important and relevant to your pull
15+
request, mention that information here. This could include
16+
benchmarks, or other information.
17+
18+
Your PR will be reviewed by a core team member and they will work with you to get your changes merged in a timely manner. If merged your PR will automatically be added to the changelog in the next release.
19+
20+
If your changes involve documentation updates please mention that and link the appropriate PR in [feathers-docs](https://github.com/feathersjs/feathers-docs).
21+
22+
Thanks for contributing to Feathers! :heart:

0 commit comments

Comments
 (0)