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

Clarify environment installation steps in CONTRIBUTING #1882

Merged
merged 3 commits into from Jul 8, 2021

Conversation

dcamron
Copy link
Member

@dcamron dcamron commented May 21, 2021

CONTRIBUTING.md had some room to catch up on our environment specification process to be more in-line with how we have it set up for CI and to more fully encompass what a user's development environment setup might look like (and preempt some potential headaches.)

@kgoebber
Copy link
Collaborator

Is it possible to capture in this PR as well, the addition of how to install the correct matplotlib for testing images? @dopplershift and I worked through this yesterday and it could be a separate PR, but seems like it could go naturally with this one that is already started.

@dcamron
Copy link
Member Author

dcamron commented May 21, 2021

Yeah, I'm gonna come back and flesh this out a little more proper next week. We created this as a demo exercise with our interns this morning!

@dcamron dcamron force-pushed the contributors-guide branch 2 times, most recently from 87378dd to 5122eba Compare June 1, 2021 23:05
@dcamron dcamron changed the title Include conda-forge in devel install Clarify environment installation steps in CONTRIBUTING Jun 1, 2021
@dcamron dcamron added Area: Docs Affects documentation Type: Maintenance Updates and clean ups (but not wrong) labels Jun 1, 2021
@kgoebber
Copy link
Collaborator

kgoebber commented Jun 8, 2021

I essentially used this to create a new environment to test something using Python 3.7 and this now captures the needed elements to get started. The only think I didn't have in the environment was git, which wasn't installed in my base environment, so while it is not a dependency at all, is that something we want to capture in the docs?

@dcamron
Copy link
Member Author

dcamron commented Jun 8, 2021

The only think I didn't have in the environment was git, which wasn't installed in my base environment, so while it is not a dependency at all, is that something we want to capture in the docs?

If this is to serve as "from zero to dev environment" (I think so) and we expect them to clone the repository for development (we do), then absolutely! I'll add and reference something about having git installed as a prerequisite.

CONTRIBUTING.md Outdated Show resolved Hide resolved
@dopplershift dopplershift added the Area: Infrastructure Pertains to project infrastructure (e.g. CI, linting) label Jun 8, 2021
@dopplershift dopplershift added this to the 1.1.0 milestone Jun 8, 2021
CONTRIBUTING.md Outdated Show resolved Hide resolved
@dcamron dcamron force-pushed the contributors-guide branch 2 times, most recently from bf5f3d4 to 16fee71 Compare July 7, 2021 18:26
Copy link
Member

@dopplershift dopplershift left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Found a couple things, but otherwise this looks great.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@dopplershift dopplershift merged commit cf8e66c into Unidata:main Jul 8, 2021
@dcamron dcamron deleted the contributors-guide branch July 8, 2021 20:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Docs Affects documentation Area: Infrastructure Pertains to project infrastructure (e.g. CI, linting) Type: Maintenance Updates and clean ups (but not wrong)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Getting started information missing
4 participants