2.2 KiB
Contributing
We want to encourage you to contribute to Floki with documentation, code and ideas. To do so, you can read the existing docs and take a look at our source code through closed pull requests.
Before starting, please read our Code of Conduct and our License files.
Docs
This project uses the ExDoc tool, which generates documentation based on code docs. Floki uses the Elixir style of writing docs.
Documentation is a very important portion of software. We want to always improve our communication using docs.
Ideas
To contribute with ideas, you can open issues using Github. Please write a clear description of what you want to propose, along with a motivation and examples.
This can make the project very rich, even if your proposal is not accepted. It worth the discussion and possible implementations.
Code
Contributing with code (and documentation) is easy if you already know how to work with Pull Request (PR) on GitHub. If you don't know yet, it's basically:
- Fork the project.
- Clone your fork using the project URL (git or https).
- Create a new branch to implement your functionality or code. This can be done with the command:
git checkout -b your-branch-name-here - Make your changes and add a new commit with a clear message saying why this change is being made.
- Push your code with the command:
git push -u origin your-branch-name-here. - Go to your fork page at GitHub.
- Open a new PR.
Today we only need a one :shipit: (it's the sign of approval) in order to merge a PR. Unfortunately we can't guarantee that all PRs will be merged. But we can guarantee that all PRs that are not accepted will have an explanation for that.
If you have questions, security issues or suggestions about the project and prefer to talk privately, please send me an email at: philip.sampaio+flokicontributing@gmail.com.
Thank you.