Skip to content

Commit 6853277

Browse files
daffldaffl
authored
chore: Edit Readme and contribution templates (#2866)
1 parent 0249791 commit 6853277

File tree

9 files changed

+371
-345
lines changed

9 files changed

+371
-345
lines changed

‎.github/FUNDING.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# These are supported funding model platforms
22

3-
github: [ daffl ]
3+
github: [daffl, marshallswain]
44
patreon: # Replace with a single Patreon username
55
open_collective: #
66
ko_fi: # Replace with a single Ko-fi username

‎.github/contributing.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,13 @@ Before running the tests from the `test/` folder `npm test` will run ESlint. You
4040

4141
### Documentation
4242

43-
Feathers documentation is contained in Markdown files in the [docs](https://github.com/feathersjs/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.
43+
Feathers documentation is contained in Markdown files in the [docs folder](https://github.com/feathersjs/feathers) of the mainr repository. To change the documentation submit a pull request to that repo, referencing any other PR if applicable, and the docs will be updated as soon as it is merged.
4444

4545
## Community Contributions
4646

4747
If you've written something awesome about Feathers, for the Feathers ecosystem, or created an app using Feathers please add it to the [awesome-feathersjs](https://github.com/feathersjs-ecosystem/awesome-feathersjs).
4848

49-
If you are looking to create a new plugin 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.
50-
51-
If you think your module would be a good core `feathersjs` module or `featherjs-ecosystem` module then please contact one of the Feathers maintainers on [Discord](https://discord.gg/qa8kez8QBx) and we can discuss whether it belongs and how to get it there. :beers:
49+
If you think your module would be a good core `feathersjs` module or [featherjs-ecosystem](https://github.com/feathersjs-ecosystem) module then please contact one of the Feathers maintainers on [Discord](https://discord.gg/qa8kez8QBx) and we can discuss whether it belongs and how to get it there. :beers:
5250

5351
## Contributor Code of Conduct
5452

‎.github/issue_template.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
### Steps to reproduce
22

33
(First please check that this issue is not already solved as [described
4-
here](https://github.com/feathersjs/feathers/blob/crow/.github/contributing.md#report-a-bug))
4+
here](https://github.com/feathersjs/feathers/blob/dove/.github/contributing.md#report-a-bug) - if it is a general question or suggestion please start a [Discussion](https://github.com/feathersjs/feathers/discussions))
55

66
- [ ] Tell us what broke. The more detailed the better.
77
- [ ] If you can, please create a simple example that reproduces the issue and link to a gist, jsbin, repo, etc. This makes it much easier for us to debug and issues that have a reproducable example will get higher priority.
88

99
### Expected behavior
10+
1011
Tell us what should happen
1112

1213
### Actual behavior
14+
1315
Tell us what happens instead
1416

1517
### System configuration

‎.github/pull_request_template.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
### Summary
22

33
(If you have not already please refer to the contributing guideline as [described
4-
here](https://github.com/feathersjs/feathers/blob/crow/.github/contributing.md#pull-requests))
4+
here](https://github.com/feathersjs/feathers/blob/dove/.github/contributing.md#pull-requests))
55

66
- [ ] Tell us about the problem your pull request is solving.
77
- [ ] Are there any open issues that are related to this?
@@ -17,6 +17,6 @@ benchmarks, or other information.
1717

1818
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.
1919

20-
If your changes involve documentation updates please mention that and link the appropriate PR in [feathers-docs](https://github.com/feathersjs/feathers-docs).
20+
If this is a new feature, please remember to add the appropriate documentation in their respective pages in the `docs` folder.
2121

22-
Thanks for contributing to Feathers! :heart:
22+
Thanks for contributing to Feathers! :heart:

‎README.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
1-
## The API and Real-time Application Framework
1+
# Feathers - The API and Real-time Application Framework
22

33
[![CI](https://github.com/feathersjs/feathers/workflows/CI/badge.svg)](https://github.com/feathersjs/feathers/actions?query=workflow%3ACI)
44
[![Maintainability](https://api.codeclimate.com/v1/badges/cb5ec42a2d0cc1a47a02/maintainability)](https://codeclimate.com/github/feathersjs/feathers/maintainability)
55
[![Test Coverage](https://api.codeclimate.com/v1/badges/cb5ec42a2d0cc1a47a02/test_coverage)](https://codeclimate.com/github/feathersjs/feathers/test_coverage)
66
[![Download Status](https://img.shields.io/npm/dm/@feathersjs/feathers.svg?style=flat-square)](https://www.npmjs.com/package/@feathersjs/feathers)
77
[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/qa8kez8QBx)
88

9-
Feathers is a lightweight web-framework for creating APIs and real-time applications using TypeScript or JavaScript.
9+
Feathers is a lightweight web-framework for creating APIs and real-time applications with TypeScript or JavaScript.
1010

1111
<a href="https://feathersjs.com" title="FeathersJS">
1212
<img src="https://user-images.githubusercontent.com/128857/173851241-b52de3b8-468d-4ac3-a4b3-eaae9c8b7f77.jpg" alt="The FeathersJS Family of Birds">
1313
</a>
1414

15-
Feathers can interact with any backend technology, supports many databases out of the box and works with any frontend technology like React, VueJS, Angular, React Native, Android or iOS.
15+
Feathers can interact with any backend technology, supports many databases out of the box and works with any frontend like React, VueJS, Angular, React Native, Android or iOS.
1616

1717
## Getting started
1818

19-
You can build your first real-time and REST API in just 4 commands:
19+
Get started with just three commands:
2020

2121
```bash
22-
$ npm init feathers my-new-app
22+
$ npm create feathers my-new-app
2323
$ cd my-new-app
24-
$ npm start
24+
$ npm run dev
2525
```
2626

27-
To learn more about Feathers visit the website at [feathersjs.com](http://feathersjs.com) or jump right into [the Feathers guides](http://docs.feathersjs.com/guides).
27+
To learn more about Feathers visit the website at [feathersjs.com](http://feathersjs.com) or jump right into [the Feathers guides](http://feathersjs.com/guides).
2828

2929
## Documentation
3030

31-
The [Feathers docs](http://docs.feathersjs.com) are loaded with awesome stuff and tell you every thing you need to know about using and configuring Feathers.
31+
The [Feathers website](http://feathersjs.com) are loaded with awesome stuff and tell you every thing you need to know about using and configuring Feathers.
3232

3333
## License
3434

0 commit comments

Comments
 (0)