Skip to content

Commit

Permalink
chore: create symlink to root readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pablo1v committed Mar 7, 2021
1 parent f9205d8 commit 8291a68
Show file tree
Hide file tree
Showing 2 changed files with 107 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
106 changes: 106 additions & 0 deletions reactools/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
<div align="center">
<a href="">
<img src="https://github.com/hitechline/react/raw/main/.github/logo.png" height="150" width="150" />
</a>

<p>Utilities to facilitate the build user interfaces with React.</p>
</div>

<div align="center">

![CodeFactor][badge-code-factor]
![Test Coverage][badge-test-coverage]
![CI Workflow Status][badge-ci-workflow-status]
![NPM Latest Version][badge-latest-npm-version]

</div>

## Overview

`@hitechline/reactools` is a library focused in facilitate a build interfaces with react.

Our proposal is to have a set of tools that are easy to use and
implement that help the developer create applications with hight
scalability.

Our focus is not just have performace hooks but a whole portfolio of resources to improve your project.

## Contributing

**Note**: We only accept contributions of specific fixes (bugs, linters or docs), new features will be implemented by the team of **Hitechline**.

##### Starting

1. Fork the repository
2. Clone the respository of your machine

##### Installing dependencies

```shell
$ yarn install
```

##### After that create your production branch

```shell
$ git checkout -b branch_name
```

Make the necessary updates to the code.

##### Ending

- Check that all tests pass

```shell
$ yarn test
```

- Add the changed files and create the commit

```shell
$ git add file_name
$ git checkout -m "commit message"
```

**Note**: Use semantic commits.

- Send the updates to github

```shell
$ git push origin branch_name
```

- Pull request with changes to branch **main**

##### Solutions

If your fork is not up to date, do the next steps below

```shell
$ git remote add upstream [email protected]:hitechline/react.git
$ git checkout main
$ git fetch upstream
$ git rebase upstream/main
$ git push origin main
```

## License

MIT © [Hitechline][url-organization]

<!-- prettier-ignore-start -->

[url-organization]: https://github.com/hitechline

[logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png

[badge-code-factor]: https://img.shields.io/codefactor/grade/github/hitechline/reactools

[badge-test-coverage]: https://img.shields.io/coveralls/github/hitechline/reactools

[badge-ci-workflow-status]: https://img.shields.io/github/workflow/status/hitechline/reactools/CI?label=ci

[badge-latest-npm-version]: https://img.shields.io/npm/v/@hitechline/reactools/latest

<!-- prettier-ignore-end -->

0 comments on commit 8291a68

Please sign in to comment.