forked from mui/material-ui-pickers
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
25 changed files
with
64 additions
and
49 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 |
---|---|---|
@@ -1,26 +1,26 @@ | ||
# Contributing | ||
|
||
:raised_hands::tada: First off all, thanks for taking the time to contribute! :tada::raised_hands: | ||
:raised_hands::tada: First of all, thanks for taking the time to contribute! :tada::raised_hands: | ||
|
||
The following is a set of guidelines for contributing to @material-ui/pickers. The purpose of these | ||
guidelines is to maintain a high quality of code _and_ traceability. Please respect these | ||
guidelines. | ||
|
||
## Setting up | ||
|
||
Please make sure that we are using `next` branch for active development. So your branches must be created from _develop_ and not from the ~~master~~. Here is a short step-by-step guide how to get started | ||
Please make sure that we are using the `next` branch for active development. So your branches must be created from _next_ and not from ~~master~~. Here is a short step-by-step guide on how to get started: | ||
|
||
1. Fork the @material-ui/pickers repository on Github | ||
2. Clone your fork to your local machine `git clone [email protected]:<yourname>/@material-ui/pickers.git` | ||
3. Checkout next `git checkout next` | ||
4. Create a branch `git checkout -b feature/my-topic-branch` | ||
5. Make your changes, lint, run tests, then push to to GitHub with `git push --set-upstream origin my-topic-branch`. | ||
5. Make your changes, lint, run tests, then push to GitHub with `git push --set-upstream origin my-topic-branch`. | ||
6. Visit GitHub and make your pull request. | ||
|
||
If you have an existing local repository, please update it before you start, to minimise the chance of merge conflicts. | ||
|
||
```sh | ||
Ugit remote add upstream [email protected]:mui-org/@material-ui/pickers.git | ||
git remote add upstream [email protected]:mui-org/@material-ui/pickers.git | ||
git checkout next | ||
git pull upstream next | ||
git checkout -b my-topic-branch | ||
|
@@ -35,13 +35,12 @@ yarn | |
yarn dev | ||
``` | ||
|
||
To start development environment and be sure the `lib` folder is linked properly to the `docs` and your changes will be applied to the docs website. | ||
to start the development environment and to be sure the `lib` folder is linked properly to the `docs` and your changes will be applied to the docs website. | ||
|
||
## General | ||
|
||
This repository use tests and a linter as automatic tools to maintain the quality of the code. | ||
These two tasks are run locally on your machine before every commit (as a pre-commit git hook), | ||
if any test fail or the linter gives an error the commit will not be created. They are also run on | ||
This repository uses tests and a linter as automatic tools to maintain the quality of the code. | ||
These two tasks are run locally on your machine before every commit (as a pre-commit git hook). If any test fails or the linter gives an error the commit will not be created. They are also run on | ||
a Travis CI machine when you create a pull request, and the PR will not be merged unless Travis | ||
says all tests and the linting pass. | ||
|
||
|
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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