Skip to content

Commit 573d416

Browse files
committed
docs: update docs
1 parent 7e4e849 commit 573d416

File tree

3 files changed

+32
-0
lines changed

3 files changed

+32
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Contributing
2+
3+
**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
4+
5+
## How to Contribute
6+
7+
1. Fork this repository;
8+
2. Create your feature branch: `git checkout -b feature/feature-name`;
9+
3. Commit your changes: `git commit -m 'feat: add some feature'`;
10+
4. Push to the branch: `git push origin feature/feature-name`.
11+
12+
**After your pull request is merged**, you can safely delete your branch.

.github/PULL_REQUEST_TEMPLATE

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
2+
<!-- If this is your first time, please read our contribution guidelines: (https://github.com/monteiro-alexandre/react-theme-switcher/.github/CONTRIBUTING.md) -->
3+
4+
<!-- If possible complete *all* sections as described. Don't remove any section. -->
5+
6+
**Changes proposed**
7+
<!--- Describe the change below, including rationale and design decisions -->
8+
9+
<!--- Include "Fixes #[issue_number]" if you are fixing an existing issue -->
10+
11+
**Additional context**
12+
<!-- Add any other context or screenshots about the feature request here. -->

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44
</a>
55
</h1>
66

7+
![build](https://github.com/monteiro-alexandre/react-theme-switcher/workflows/build/badge.svg?branch=master)
8+
[![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
9+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
10+
711
Lading page with Dark/Light theme switcher.
812

913
## 💻 Technologies
@@ -41,6 +45,10 @@ yarn start
4145

4246
To view the project you can open [localhost:3000](http://localhost:3000).
4347

48+
## 🤔 Contributing
49+
50+
Please read [CONTRIBUTING.md](.github/CONTRIBUTING.md) for details on the code of conduct and the process for submitting pull requests.
51+
4452
## License
4553

4654
This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.

0 commit comments

Comments
 (0)