Development Overview

---

Thanks for contributing to Fidescls! This section of the docs is designed to help you become familiar with how we work, the standards we apply, and how to ensure your contribution is successful.

If you're stuck, don't be shy about asking for help on GitHub.

Getting Started

The first step is to clone the Fidescls repo for development:

git clone https://github.com/ethyca/fidescls

Once that's complete, there are a few different ways to spin up the project and get coding!

Developer Workflows

There are a few different ways to develop Fidescls, they are listed below:

1. One of the best ways to work on Fidescls is by utilizing the Makefile commands. (Make sure that you have docker, docker-compose and make installed)
2. CLI
   1. .
   2. Once you have everything set up, run make cli to spin up a shell within the fidescls container.
   3. You can and should run all of your various development commands from within this shell, such as pytest, black, etc.
3. API
   1. Since the container is updated live, development can be done while the api is running and code changes are being made.
   2. Running make api will spin up the api server within the fidescls container
   3. Requests can be made to the api, at the appropriate address and endpoint, while observing the logs in the terminal.
4. The least-recommended method would be to install the project in your local environment and develop directly.

Write your code

We have no doubt you can write amazing code! However, we want to help you ensure your code plays nicely with the rest of the Fidescls ecosystem. Many projects describe code style and documentation as a suggestion; in Fidescls it's a CI-checked requirement.

• To learn how to style your code, see the style guide.
• To learn how to document your code, see the docs guide.
• To learn how to test your code, see the tests guide.
• To learn what format your PR should follow, make sure to follow the pull request guidelines.

Submit your code

In order to submit code to Fidescls, please:

• Fork the Fidescls repository
• Create a new branch on your fork
• Open a Pull Request once your work is ready for review
• Once automated tests have passed, a maintainer will review your PR and provide feedback on any changes it requires to be approved. Once approved, your PR will be merged into Fidescls.

Congratulations

You're a Fidescls contributor - welcome to the team! 🎉