43 lines
1.8 KiB
Markdown
43 lines
1.8 KiB
Markdown
# Contributing to Ultrasonic
|
|
|
|
Tank you very much for taking the time to contribute! :+1:
|
|
|
|
Here you will find guidelines for contributing to Ultrasonic. Feel free to propose changes to this document in a pull request.
|
|
|
|
## Code Conduct
|
|
|
|
This project and everyone participating in it is governed by the [Ultrasonic Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [erick.simoes@live.com](mailto:erick.simoes@live.com).
|
|
|
|
## I have a question
|
|
|
|
Soon we will have a Wiki, until there, you can get your questions through (in order of preference):
|
|
- GitHub issues
|
|
- posting a message on [Makerama](https://www.facebook.com/groups/makerama/?source_id=449693438550360)'s group on Facebook
|
|
- sending a message on [Makerama](https://www.facebook.com/Makerama.br/)'s page on Facebook
|
|
- send a email to [erick.simoes@live.com](mailto:erick.simoes@live.com)
|
|
> Note: Prefer to ask your question through some public channel, so that others can learn too
|
|
|
|
## Ways to help this project:
|
|
1. Using
|
|
- Use this library in your projects (open source or privates),
|
|
> Note: You will make the day of the creator of this lib very happy to tell him that you are using in your project :+1:
|
|
2. Testing
|
|
- Use the features and try in various devices.
|
|
3. Suggesting a feature
|
|
- Do you need some feature? Suggest it as a issue.
|
|
4. Notifying a bug
|
|
- Did you notice any strange behavior? Reporter the bug as a issue!
|
|
5. Implementing
|
|
- You can do enhancement, fix a bug, solve an issue or expand the documentation.
|
|
|
|
## Premises:
|
|
This project was elaborated following some premises:
|
|
#### Minimalism:
|
|
- The minimum memory consumption;
|
|
- The minimum of features;
|
|
- Code minimum.
|
|
#### Oriented to the developer experience
|
|
- As simple as possible to use.
|
|
|
|
Thanks! :heart:
|