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

📝 Add direction to work from a branch of main repo rather than a fork #193

Closed
e-lo opened this issue Dec 1, 2023 · 3 comments · Fixed by #194
Closed

📝 Add direction to work from a branch of main repo rather than a fork #193

e-lo opened this issue Dec 1, 2023 · 3 comments · Fixed by #194
Assignees
Labels
📙 docs Elaborating or updating the documentation – inline or otherwise

Comments

@e-lo
Copy link
Contributor

e-lo commented Dec 1, 2023

Per @Danishswag's recent contribution – this needs to be made more obvious in CONTRIBUTING.md

@e-lo e-lo added the 📙 docs Elaborating or updating the documentation – inline or otherwise label Dec 1, 2023
@e-lo e-lo self-assigned this Dec 1, 2023
@Danishswag
Copy link

As a follow-up to this, if we're updating CONTRIBUTING.md anyway, another issue I ran into is that the tests it recommends running also requires the packages in docs/requirements.txt too since the first test script (tests/test_local_spec) builds the docs locally.

If we want to keep the test suite as is, we could maybe just merge the two requirements files?

@e-lo
Copy link
Contributor Author

e-lo commented Dec 1, 2023

The first requirement in requirements.txt is the docs/requirements.txt, and then the development setup instructions in CONTRIBUTING.md says:

Install development requirements packages pip install -r requirements.txt or in a virtual environment.

image

Is there somewhere else we should add this instruction?

@Danishswag
Copy link

Must have been an issue with my Python install, please feel free to ignore

@e-lo e-lo closed this as completed in #194 Dec 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📙 docs Elaborating or updating the documentation – inline or otherwise
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants