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

Work on Installation and Developer Documentation #11

Open
rmmilewi opened this issue Feb 28, 2021 · 2 comments
Open

Work on Installation and Developer Documentation #11

rmmilewi opened this issue Feb 28, 2021 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@rmmilewi
Copy link
Member

@frobnitzem @elaineraybourn I'm putting this here as a to-do list for after we merge in the branch associated with #10. I've been thinking about what remains to be done to make it easy for a new developer to contribute to our project, especially since we may have interns coming on board who will be available to contribute to our work. Here's what's on my list to get done with before the start of the summer:

  1. Put together a setup.py script and requirements.txt script to make it easy to install all of the dependencies that Reposcanner requires.
  2. The Sandia virtual intern(s) may be doing their work via some Windows Desktop-as-a-Service (DaaS) running their personal machines. If they have to do work on the VPN and/or via some DaaS setup, we need to provide instructions for how to build and run Reposcanner in this environment. Otherwise they might spend weeks just figuring out how to resolve proxy issues, and I'd rather skip that step.
  3. I need to author some developer documentation that not only explains what the different components of Reposcanner are, but also how to add new features to the tool. Like if an intern wants to set up a new mining routine, how do they do that? This should be made clear in the documentation.
  4. Set up continuous integration support so we can guarantee that Reposcanner has passing builds/tests from commit to commit, especially if we're going to have multiple developers working on the codebase concurrently. This could be via TravisCI, GitHub Actions, etc. I'm open to ideas here.
  5. I need to revisit the sources we collected from that literature review and boil it down to a write-up that would help any prospective contributors get up-to-speed on what we're interested in doing with Reposcanner.
@rmmilewi rmmilewi added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 28, 2021
@rmmilewi rmmilewi self-assigned this Feb 28, 2021
@rmmilewi
Copy link
Member Author

For step 1 on this issue, I've created a new branch (AddInstallationCapabilities), and I'll be using Pyscaffold to add in easy installation support as @frobnitzem suggested. Then I can set up continuous integration support, possibly using GitHub Actions (step 4), then I'll be able to circle back around to steps 2 and 3.

@rmmilewi
Copy link
Member Author

Note: I'm going to merge that branch into the main branch so I can also set up GitHub Actions on the main branch. I will work to get the PyScaffold-generated files in working order.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant