Open source

Contributing

apix is open source and pull requests are welcome. Here is everything you need to get started.

Workflow

1Fork the repository on GitHub

2Clone your fork

bash

git clone https://github.com/<your-username>/apix.git && cd apix

3Create a feature branch
bash
```
git checkout -b feature/my-feature
```
4Make your changes, then run the checks

5Commit and push

bash

git add -p && git commit -m 'feat: my feature' && git push origin feature/my-feature

6Open a Pull Request against CianusDev/apix

Development commands

Run these before opening a PR to make sure everything passes.

Run all tests

bash

cargo test

Lint with Clippy

bash

cargo clippy -- -D warnings

Format the code

bash

cargo fmt

Pull requests welcome

Bug fixes, features, documentation improvements — all contributions are appreciated.

Open on GitHub

License

apix is released under the MIT License. You are free to use, modify and distribute it.

LICENSE

MIT License

Copyright (c) 2024 CianusDev

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.