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

Fix dev environment/testing install instructions #2958

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from

Conversation

sgkasselau
Copy link

Hi,

I've put together a few fixes to the development environment/testing installation instructions.

Particularly clarifying how to:

  • install Prover9 (needed for the inference doctest);
  • get set up in pipenv (useful if you have many projects, and don't want to contaminate your user-level Pip setup);
  • get Gitflow set up, including how to start a branch using it;
  • how to run the test suite successfully via Tox (particularly in pipenv.)

(I struggled with this on a new machine, so figured I should document it for others!)

Included also is:

  • a small fix to a doctest, inference.doctest, to allow it to work with Prover9 2009-11A; and,
  • a small enhancement to tox.ini to allow individual tests to be run

Hope this is useful to you!

…lternative steps, more Gitflow usage/elaborations, and more accurate tox installation steps.
…e a slightly different output to that expected.
@tomaarsen
Copy link
Member

Hey!
To clarify, the prover9-related tests should automatically skip if prover9 is not installed. Most users won't be making changes to this, and thus I wouldn't consider installing prover9 a requirement for new developers. That said, the documentation changes are definitely useful, although I happen to use a different module for my virtual environments.

On that note, I'm not sure whether we should go that detailed with it. Although it helps completely new developers, simply recommending users to use some virtual environment tool might be preferable, as more experienced developers can use whatever tool they are familiar with.

The same goes with git-flow. People have personal preferences here, and perhaps it's best to mention the simplest solution (i.e. as right now, I believe). I'm willing to hear others' thoughts on this though.

@sgkasselau
Copy link
Author

Hi Tom!

Thanks for getting back to me!

To explain my choices a bit more, I added the instructions for Prover9 as there didn't seem to be any instructions for this alongside the code itself on how to do this. (And, well, inference is where I'm currently developing other changes, so I wanted this to be clear as possible so that my later work yet-to-come is more accessible.)

Pipenv instructions are elsewhere in CONTRIBUTING.md already, so I added instructions for pipenv where there were existing pip related ones for consistency's sake. So that one environment management tool wasn't being favoured over the other.

I added elaborating documentation on git-flow because CONTRIBUTING.MD already mentioned that the project uses it, and I felt it needed more explanation on how to get started with it. NLTK has a slightly non-standard branching model (i.e. there's no main or master branch) so I wanted to provide the right instructions to make this work alongside the other git-flow documentation.

Hope this helps explain my motivations better?

(Please let me know if you'd like me to withdraw some or all of the CONTRIBUTING.md documentation changes?)

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

Successfully merging this pull request may close these issues.

None yet

2 participants