docs: added CONTRIBUTING.md, improved README.md and CHANGELOG.md

Signed-off-by: António Pedro <[email protected]>

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 6.1.0-unreleased
+
+* Added customizations options for the bottom navigation bar such as `shadowColor`, `showElevation`, `blurRadius`, `spreadRadius`, `shadowOffset`, `borderRadius`, and `itemPadding`.
 
 ## 6.0.0
 
@@ -22,48 +25,63 @@
 * Added `textAlign` property in `BottomNavyBarItem` to change the alignment of the item title
 
 ## 5.2.2
- * Added [mainAxisAlignment] property to align the items in the navigation bar
+
+* Added [mainAxisAlignment] property to align the items in the navigation bar
 
 ## 5.2.1 
+
 * Added [itemCornerRadius] property to change the active item's corner radius
 
 ## 5.2.0 
+
 * Added optional parameter animationDuration to BottomNavyBar
 * Fixed issue, that selectedIndex has to be final in StatefulWidget
 * BottomNavyBar changed to StatelessWidget
 
 ## 5.1.0 
+
 * Added assertion to prevent more than five items
 
 ## 5.0.0 
+
 * Fixed: Bar is too low at iPhone X(s/R)
 
 ## 4.2.0 
+
 * Fixed the width of the Bottom navigation bar
 
 ## 4.1.0 
+
 * Added support to hide/show appBar's elevation
 
-## 4.0.0 
+## 4.0.0
+
 * Fixed: Can't set default active item before Tap
 
-## 3.0.0 
+## 3.0.0
+
 * Animation duration set to 270 milliseconds && code improved.
 
-## 2.2.0 
+## 2.2.0
+
 * Icon now have default inactive color as the active color (bug fixed).
 
-## 2.1.0 
+## 2.1.0
+
 * Icon now have default inactive color as the active color.
 
-## 2.0.0 
+## 2.0.0
+
 * Full update & more improved.
 
-## 1.1.1 
+## 1.1.1
+
 * First stable version.
 
-## 0.1.1 
+## 0.1.1
+
 * Few updates.
 
-## 0.1.0 
+## 0.1.0
+
 * Initial beta release.

CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing
+
+Contributions are welcome and will be fully credited.
+
+## Before
+
+You can contribute by:
+
+* Raising any issues you find using BottomNavyBar
+* Fixing issues by opening Pull Requests
+* Improving documentation
+* Talking about BottomNavyBar
+
+All bugs, tasks or enhancements are tracked as [GitHub issues][https://github.com/pedromassango/bottom_navy_bar/issues]. Issues that might be a good start for new contributors are marked with the `good first issue` label.
+
+We recommend you get in touch with us before contributing, you can do that by:
+- openning a new issue
+- or start a new discussion.
+
+## After
+
+If you are ready with your PR, please make sure to include the following:
+- A clear title, e.g `Added new feature: ...`, `Fixed bug: ...`
+- A meaningful description of your changes, e.g `Added new feature that does ...`, `Fixed bug where ...`
+- Add and make sure all tests pass
+- Make sure to update the `CHANGELOG.md` file with your changes. Please follow the same format as the other entries there.
+- If your PR is related to an existing issue, make sure to link it in your PR description.
+- If your PR is related to a bug, please provide steps to reproduce the issue.

README.md

@@ -156,3 +156,12 @@ class _MyHomePageState extends State<MyHomePage> {
   }
 }
 ```
+
+## Contributions
+
+Contributions of any kind are more than welcome! Feel free to fork and improve in any way you want, make a pull request, or open an issue.
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for more info on how to contribute to this project.
+
+# License
+
+This project is licensed under the Apache-2.0 License - see the [LICENSE](./LICENSE) file for details.