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

First draft of numfocus_onepager. #1

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

rossbar
Copy link

@rossbar rossbar commented Apr 8, 2021

I wasn't able to find NumFOCUS's one-pager template that was mentioned in the meeting, but I got a pretty good idea of what they're looking for by reading some of the one-pager's in the 2020 annual report. Unfortunately there doesn't seem to be a web link, so the only way to view this is to download the report, then ctrl+f for "one-page" and click on the icons to download the individual one-pagers for projects.

Anyways, to summarize what I got from reading several of these is that there are four main sections:

  1. A project summary - short paragraph, high level
  2. A section entitled either "Use Cases" or "Applications" that describes how the project is typically used. 3 bullets total.
    • Most projects provide specific examples here (e.g. the Event Horizon Telescope uses NumPy, Amazon AWS uses conda-forge, etc.)
  3. A "Planned Features" section - Big-ish refactors/features that your project aims to undertake. 3 bullets total.
  4. A "Project Needs" section that reads like "if you had money, what would you spend it on, and how much work do you estimate each of the listed projects would require". 3 bullets total.

I've done my best to seed each of these sections. The summary I derived largely from the landing page at networkx.org, but it could certainly be improved.

Section 2 was the one I had most trouble with: I added some high-level bullets to represent generic "use-cases", but I think it would be better if we had specific, concrete examples. I did a quick perusal of our dependencies on GitHub to try to come up with ideas.

I seeded section 3 mostly by grabbing bullets out of the roadmap.

Finally, for the "project needs" section, I tried to capture a couple of the things we've discussed in past meetings/grant proposals. Most projects provide a dollar amount for each bullet, but I noticed that conda gave their "needs" in terms of developer-hours. I thought that gave us more wiggle room so I copied that pattern, though the values I came up with were basically arbitrary (1 developer-year each for visualization & interop/computations backend, etc.).

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

Successfully merging this pull request may close these issues.

1 participant