Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
Signed-off-by: 1998-felix <[email protected]>
  • Loading branch information
felixgateru committed Aug 24, 2023
1 parent d501716 commit 811aa4d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 14 deletions.
11 changes: 5 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Reporting issues are a great way to contribute to the project. We are perpetuall
thorough bug report.

Before raising a new issue, check [our issue
list](https://github.com/mainflux/docs/issues) to determine if it already contains the
list](https://github.com/mainflux/embedded/issues) to determine if it already contains the
problem that you are facing.

A good bug report shouldn't leave others needing to chase you for more information. Please be as detailed as possible. The following questions might serve as a template for writing a detailed
Expand Down Expand Up @@ -41,23 +41,22 @@ To contribute to the project, [fork](https://help.github.com/articles/fork-a-rep
clone your fork repository and configure the remotes:

```
git clone https://github.com/<your-username>/docs.git
git clone https://github.com/<your-username>/embedded.git
cd docs
git remote add upstream https://github.com/mainflux/docs.git
```
git remote add upstream https://github.com/mainflux/embedded.git
If your cloned repository is behind the upstream commits, then get the latest changes from upstream:
```
git checkout master
git pull --rebase upstream master
git pull --rebase upstream main
```
Create a new topic branch from `master` using the naming convention `MF-[issue-number]`
to help us keep track of your contribution scope:
```
git checkout -b MF-[issue-number]
git checkout -b MBD-[issue-number]
```
Commit your changes in logical chunks. When you are ready to commit, make sure
Expand Down
8 changes: 0 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,3 @@ Thank you for your interest in Mainflux and the desire to contribute!
## License

[Apache-2.0](LICENSE)

[gitter]: https://gitter.im/mainflux/mainflux?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
[gitter-badge]: https://badges.gitter.im/Join%20Chat.svg
[license]: https://img.shields.io/badge/license-Apache%20v2.0-blue.svg
[blog]: https://medium.com/mainflux-iot-platform
[twitter]: https://twitter.com/mainflux
[docs]: https://docs.mainflux.io
[build]: https://github.com/mainflux/docs/actions/workflows/main.yaml/badge.svg

0 comments on commit 811aa4d

Please sign in to comment.