Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

YAML file format in LocalFilesystemBackend #9417

Closed
4 tasks
mik-laj opened this issue Jun 19, 2020 · 3 comments · Fixed by #9477
Closed
4 tasks

YAML file format in LocalFilesystemBackend #9417

mik-laj opened this issue Jun 19, 2020 · 3 comments · Fixed by #9477

Comments

@mik-laj
Copy link
Member

mik-laj commented Jun 19, 2020

Hello,

I would be happy if LocalFilesystemBackend would support YAML files. This file format is easier for human editing than JSON files, so it would be easier for developers to use.

Tasks to do

  • 1. Define the file format (based on the current JSON format)
  • 2. Add support for YAML files
  • 3. Add tests
  • 4. Upddate docs

Steps 2 and 3 can be swapped if TDD methodology will be used. It will be easy here, so it will be an good exercise.

If anyone is interested in this, I am willing to provide all the necessary tips and information.

Are you wondering how to start contributing to this project? Start by reading our contributor guide

Cheers

@mik-laj mik-laj changed the title YAML support in LocalFilesystemBackend YAML file format in LocalFilesystemBackend Jun 19, 2020
@VinayGb665
Copy link
Contributor

VinayGb665 commented Jun 22, 2020

I would like to pick this up.
So the YAML structure would be similar to the current JSON right?.If I am not wrong the JSON structure from here should be used as reference.

@mik-laj
Copy link
Member Author

mik-laj commented Jun 22, 2020

@VinayGb665 I assigned you to this ticket. I look forward to your contributions. 🐈

@mik-laj
Copy link
Member Author

mik-laj commented Jun 22, 2020

@VinayGb665 Yes. It may be based on this, but if you have your idea then you can present it in your change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants