TIDES-transit / TIDES

Transit ITS Data Exchange Specification for historical transit operations data
https://tides-transit.github.io/TIDES
Apache License 2.0
27 stars 4 forks source link

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

Closed e-lo closed 11 months ago

e-lo commented 11 months ago

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

Danishswag commented 11 months ago

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 commented 11 months ago

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 commented 11 months ago

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