Context
The EDITO ecosystem is offering a lot of integration, while also securing your work environment for scientists, developers, project managers, etc. While this can be viewed as constraints, using this set of good practices can help you make the most of the platform and learning new healthy habits.
⚠️ Launched services are meant to be temporary. The injected tokens are valid 24 hours for security reason, but the service configuration can be saved to find your setup again in one click.
The idea is to create a reproducible environment while benefiting from the best security recommendation.
Versioning your code
The most popular version control software system is git. If you are working under an organization, it probably has its own Gitlab/Github/SourceForge/Bitbucket instance. The main points when using git:
We recommend you create a repository when starting a project, or reuse the existing one when taking over someone else's work.
Create a branch to split between what is working or in production (main branch), and your developments (feature branch).
Commit and push your changes regularly. Either after you manage to have something working or at the end of your day.
💡 EDITO Pro Tip: you can consult the Git Cheat Sheet anytime to remember commands. If you are not familiar with git, you can find lots of resources online to learn the basics. Or you can play a fun little game called Oh My Git!.
Tracking your dependencies
During your development, you will probably test some libraries, use various input data or rely on external services. While those dependencies appear in the code, some actions are needed when onboarding on a project to be able to run it.
Most programming languages offer a packaging system for distributing support libraries. For example, in Python, you can manage your dependencies with pip. You can trace your dependencies in a requirements file, and then commit it in your repository.
Try to keep in mind to do not rely on the implicit existence of any system tools (for example curl, tar). While these tools may exist on many or even most systems, there is no guarantee that they will exist on all systems where the code may run in the future.
What's next?
If you have any questions, problems, or suggestions, please feel free to contact us via chat using the widget available at the bottom right of the page.