-
Notifications
You must be signed in to change notification settings - Fork 505
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add CONTRIBUTING.md and update instructions
- Loading branch information
Showing
2 changed files
with
53 additions
and
17 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,39 @@ | ||
# Contributing to MERN CRUD | ||
|
||
Thank you for considering contributing to this little project! | ||
|
||
<br> | ||
|
||
## Features you are encouraged to implement | ||
|
||
* Tests | ||
* Search | ||
* Front-end validation (JS); Pure back-end validation is expensive | ||
* Routing / redirecting / whatever | ||
* Redux | ||
|
||
## Coding conventions | ||
* Indent using two spaces (soft tabs). | ||
* Integrate *eslintrc.json* to your text editor or IDE. | ||
|
||
|
||
<br> | ||
|
||
## Fork, then clone the repo. | ||
```bash | ||
git clone https://github.com/<your-user-name>/mern-crud.git | ||
``` | ||
|
||
## Commit | ||
Make sure your commit messages are in present tense. | ||
|
||
This: | ||
```bash | ||
git commit -m "Fix bugs and update colors" | ||
``` | ||
Not this: | ||
```bash | ||
git commit -m "Fixed bugs and updated colours" | ||
``` | ||
|
||
## Push to your Fork and make a pull request. |
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