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

Update Contributing.md and Demos to match current repo structure #518

Closed
HammadTheOne opened this issue Oct 3, 2020 · 1 comment · Fixed by #547 or #548
Closed

Update Contributing.md and Demos to match current repo structure #518

HammadTheOne opened this issue Oct 3, 2020 · 1 comment · Fixed by #547 or #548
Assignees
Labels
housekeeping Issues that are unrelated to functionality (e.g., docstrings).

Comments

@HammadTheOne
Copy link
Contributor

Some parts of the CONTRIBUTING.md require updates to bring it in line with the currently applied process in the dash-bio repo. Alternatively, the directories in the repo that don't comply with the contributing guidelines can be updated to match best practices. For example the following instructions specify snake_case, but the sub-directories' names are hyphenated and include an app.py.

In the `tests/dashbio_demos/` subfolder, please create a file named
`app_{your component name in snake case}.py`. In this file, please include the

Similarly, the following subfolder and (I believe) the gallery structure no longer exist.

In the `tests/dashbio_demos/images/` subfolder, please include a PNG file named
`pic_{your component name in snake case}.png`.
@HammadTheOne HammadTheOne added the housekeeping Issues that are unrelated to functionality (e.g., docstrings). label Oct 3, 2020
@HammadTheOne
Copy link
Contributor Author

HammadTheOne commented Feb 2, 2021

As part of this housekeeping issue, we can also address some changes required to run the dashbio_demos template apps locally after the repo was restructured in #459.

It includes the following points of interest:

@HammadTheOne HammadTheOne changed the title Update Contributing.md to match current repo structure Update Contributing.md and Demos to match current repo structure Feb 18, 2021
@HammadTheOne HammadTheOne self-assigned this Feb 18, 2021
This was referenced Mar 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
housekeeping Issues that are unrelated to functionality (e.g., docstrings).
Projects
None yet
1 participant