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 docs for local development environment set-up #1848

Merged
merged 5 commits into from Nov 4, 2017

Conversation

Projects
None yet
3 participants
@jacksonllee
Contributor

jacksonllee commented Oct 5, 2017

This PR provides more explicit notes for how to set up a local development environment. Hopefully the notes will be helpful for getting more people started with contributions.

@stevenbird

This comment has been minimized.

Show comment
Hide comment
@stevenbird

stevenbird Oct 5, 2017

Member

@jacksonllee, thanks for this. Yes I would prefer not to suggest all, given the demands we already place on GitHub.

Member

stevenbird commented Oct 5, 2017

@jacksonllee, thanks for this. Yes I would prefer not to suggest all, given the demands we already place on GitHub.

@stevenbird stevenbird self-assigned this Oct 6, 2017

@stevenbird

This comment has been minimized.

Show comment
Hide comment
@stevenbird

stevenbird Oct 9, 2017

Member

@jacksonllee: here's where we list collections of corpora. Would you mind submitting a PR there for tests.xml please?

https://github.com/nltk/nltk_data/tree/gh-pages/collections

Member

stevenbird commented Oct 9, 2017

@jacksonllee: here's where we list collections of corpora. Would you mind submitting a PR there for tests.xml please?

https://github.com/nltk/nltk_data/tree/gh-pages/collections

@jacksonllee jacksonllee referenced this pull request Oct 10, 2017

Merged

Add tests.xml #93

@jacksonllee

This comment has been minimized.

Show comment
Hide comment
@jacksonllee

jacksonllee Oct 10, 2017

Contributor

@stevenbird Done, tests.xml added at nltk/nltk_data#93

Contributor

jacksonllee commented Oct 10, 2017

@stevenbird Done, tests.xml added at nltk/nltk_data#93

- Create a new branch off of `develop` with a descriptive name (for example:
`feature/portuguese-sentiment-analysis`, `hotfix/bug-on-downloader`). You can
do it switching to `develop` branch (`git checkout develop`) and then
creating a new branch (`git checkout -b name-of-the-new-branch`);
- Do many small commits on that branch locally (`git add files-changed`,
`git commit -m "Add some change"`);
- Add your name to the `AUTHORS.markdown` file as a contributor;
- Run the tests to make sure nothing breaks
(`tox -e py35` if you are on Python 3.5);

This comment has been minimized.

@alvations

alvations Oct 13, 2017

Contributor

👍

@alvations

alvations Oct 13, 2017

Contributor

👍

Show outdated Hide outdated CONTRIBUTING.md

jacksonllee added some commits Oct 23, 2017

Remove recommendation for installing nltk in dev mode
nltk doesn't necessarily have to be installed for tests
to run, so long as one is at the repo root directory
and the `nltk/` directory is available as a local
relative-path package.
@jacksonllee

This comment has been minimized.

Show comment
Hide comment
@jacksonllee

jacksonllee Oct 23, 2017

Contributor

@stevenbird @alvations Requested changes made -- ready for another pass.

Contributor

jacksonllee commented Oct 23, 2017

@stevenbird @alvations Requested changes made -- ready for another pass.

@alvations

This comment has been minimized.

Show comment
Hide comment
@alvations

alvations Nov 3, 2017

Contributor

Thanks @jacksonllee! hopefully the updated contribute.md ease first time contributors pain =)

I think it LGTM.

Contributor

alvations commented Nov 3, 2017

Thanks @jacksonllee! hopefully the updated contribute.md ease first time contributors pain =)

I think it LGTM.

@stevenbird stevenbird merged commit 79596d5 into nltk:develop Nov 4, 2017

1 check passed

NLTK tests Build finished.
Details
@stevenbird

This comment has been minimized.

Show comment
Hide comment
@stevenbird
Member

stevenbird commented Nov 4, 2017

@jacksonllee jacksonllee deleted the jacksonllee:docs-for-local-dev-env branch Nov 6, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment