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

Clarify unit test workflow #321

Closed
Maghnie opened this issue Sep 4, 2024 · 2 comments · Fixed by #322
Closed

Clarify unit test workflow #321

Maghnie opened this issue Sep 4, 2024 · 2 comments · Fixed by #322
Assignees
Labels
documentation question Further information is requested

Comments

@Maghnie
Copy link
Contributor

Maghnie commented Sep 4, 2024

Current situation:

Currently, there are seemingly three ways of setting up the environment for the unit tests but apparently only one works (for me).

  1. The tests readme says to create a '.env.filip' file
  2. The included .env template says to create a '.env' file
  3. There's a third env file called 'test_config.env'. Not sure if this serves a different purpose.

Suggestion:

  1. Update the readme to refer to a '.env' file
  2. Remove 'test_config.env' and any corresponding references?
@Maghnie Maghnie added question Further information is requested documentation labels Sep 4, 2024
@Maghnie
Copy link
Contributor Author

Maghnie commented Sep 4, 2024

@djs0109 Thoughts?

@djs0109
Copy link
Contributor

djs0109 commented Sep 5, 2024

Thank you for reporting this importing issue. Yes, we must revise the readme in tests.

  1. It is outdated. the .env.filip should only be needed for filip examples and tutorials
  2. It is correct
  3. test_config.env is needed for a unittest

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation question Further information is requested
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants