diff --git a/CHANGELOG.md b/CHANGELOG.md index 1c0d6bb..9fc9896 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ All notable changes to Pixano will be documented in this file. ### Added - Add GitHub actions to format Python, UI, and Markdown code +- Add CONTRIBUTING.md for installation information and contribution guidelines ### Changed diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..237dedc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +# Contributing to Pixano Inference + +Thank you for your interest in Pixano Inference! Here you will find information on running Pixano Inference locally and guidelines on how to publish your contributions. + +## Getting started + +### Issue and suggestions + +If you find a bug or you think of some missing features that could be useful while using Pixano Inference, please [open an issue](https://github.com/pixano/pixano-inference/issues)! + +### Modifications + +To contribute more actively to the project, you are welcome to develop the fix or the feature you have in mind, and [create a pull request](https://github.com/pixano/pixano-inference/pulls)! + +And if you want to change the module to your liking, feel free to [fork this repository](https://github.com/pixano/pixano-inference/fork)! + +## Running Pixano Inference locally + +If you are looking to contribute to Pixano Inference and develop new features, you will need to clone the Pixano Inference repository and run it locally. + +### Requirements + +You will need `python == 3.10`. Then, inside the root `pixano_inference/` directory, run this command to install all the Python dependencies: + +```bash +pip install . +``` + +## Formatting the code + +We use these extensions for formatting the Pixano Inference source code: + +- Black: Python, Jupyter + - https://marketplace.visualstudio.com/items?itemName=ms-python.black-formatter +- Prettier: Typescript, Javascript, Svelte, HTML, CSS, JSON, YAML, Markdown + - https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode + - https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode + +## Updating the changelog + +When you want to create a pull request with the changes you have made, please update the CHANGELOG.md accordingly. diff --git a/README.md b/README.md index 3cbdaac..d691e09 100644 --- a/README.md +++ b/README.md @@ -29,11 +29,7 @@ Please refer to [these Pixano notebooks](https://github.com/pixano/pixano/tree/m # Contributing -If you find a bug or you think of some missing features that could be useful while using Pixano Inference, please [open an issue](https://github.com/pixano/pixano-inference/issues)! - -To contribute more actively to the project, you are welcome to develop the fix or the feature you have in mind, and [create a pull request](https://github.com/pixano/pixano-inference/pulls)! - -And if you want to change the module to your liking, feel free to [fork this repository](https://github.com/pixano/pixano-inference/fork)! +Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) for information on running Pixano locally and guidelines on how to publish your contributions. # License