Beagle-helpers
Table of Contents
1. About
2. Usage
2.1. Configuration
3. Documentation
4. Contributing
5. Code of Conduct
6. License
7. Community
About
Beagle Helpers is a solution to facilitate the use of the Beagle framework in Android, iOS, or Web projects
The initial setup of Beagle requires quite a few classes and configurations and, in order to make this process faster and more dynamic, each platform has developed a few libs.
Usage
Configuration
You will find Android, iOS and WEB repositories for libs or scripts that assists in implementing a Beagle Framework in your project:
- Android libs
- iOS libs
- Web libs
Documentation
You can find Beagle's documentation on our website.
Beagle's documentation discusses components, APIs, and topics that are specific to Beagle documentation.
Contributing
If you want to contribute to this module, access our Contributing Guide to learn about our development process, how to propose bug fixes and improvements, and how to build and test your changes to Beagle.
Developer Certificate of Origin - DCO
This is a security layer for the project and for the developers. It is mandatory.
Follow one of these two methods to add DCO to your commits:
1. Command line Follow the steps: Step 1: Configure your local git environment adding the same name and e-mail configured at your GitHub account. It helps to sign commits manually during reviews and suggestions.
git config --global user.name “Name”
git config --global user.email “[email protected]”
Step 2: Add the Signed-off-by line with the '-s' flag in the git commit command:
$ git commit -s -m "This is my commit message"
2. GitHub website You can also manually sign your commits during GitHub reviews and suggestions, follow the steps below:
Step 1: When the commit changes box opens, manually type or paste your signature in the comment box, see the example:
Signed-off-by: Name < e-mail address >
For this method, your name and e-mail must be the same registered on your GitHub account.
Code of Conduct
Please read the code of conduct.
License
Community
Do you have any question about Beagle? Let's chat in our forum.