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

Project Documentation: Application Process Doc section #25

Open
quintessence opened this issue Apr 12, 2023 · 1 comment
Open

Project Documentation: Application Process Doc section #25

quintessence opened this issue Apr 12, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation project-docs Documentation about projects on website

Comments

@quintessence
Copy link
Contributor

Documentation Section for Adding New Projects:

What Nivenly Provides

Transparency around what we can assist a project with. Will need to dive into both the succinct and significantly-less-succinct descriptions of this. Some things to include:

  • Governance
  • Trademarks
  • Networking to augment devs
    • Esp important for new and/or solo-maintainer projects

Mechanics of How to Apply

  • They contact us via email to express interest and some initial information about the project, where they're at with it. This should be no different than any other intro-type email.
    • Alternatively, we can also make a simple form for users to reach us to express interest and we respond?
  • We generate a Google Doc that they complete
    • Documentation page should include the expectations for what that doc will request.
      • Once ready, we can include a couple of projects with applications that we've liked for people to see what "good" looks like in terms of how much detail and what kind to include.
  • They let us know when the doc is complete (and ask clarifying questions to get it into a good state)

How Nivenly Processes Applications

Transparency in how projects are evaluated and accepted as a Nivenly project.

  • First year the board is making individual decisions. Later years will involve more collaboration.
  • Part of being an early project will be helping ironing out processes to make them more beneficial and streamlined for future years.
    • As relates to governance that interfaces with Nivenly.

The Projects Themselves

  • Each project should have a page on the wiki that has a minimum of one paragraph and a maximum of ~500 words (~1 printed page) of description.
  • Each project page should include a link to the GitHub repo or org and individual website (if there is one).
  • Project header information will look something like:
    • Project Name: NAME
    • Project Maintainers: NAME, LIST, LINK (to page and/or GitHub contribs) - will need some consistency but also a way that the info isn't impossible to maintain over time.
    • Project Data: LIST OF LINKS (not to be confused with a linked list 😉 ) -> GitHub, web page, etc. all here.
    • Project Description: This is the 1 ¶ - 1 page description of the project.
    • Will need consistent placement of project logos if/when present.
@quintessence quintessence added the documentation Improvements or additions to documentation label Apr 12, 2023
@quintessence quintessence self-assigned this Apr 12, 2023
@quintessence quintessence added the project-docs Documentation about projects on website label Apr 12, 2023
@quintessence
Copy link
Contributor Author

When writing the above what the project chooses to include should be actionable so that it is possible to see how / where / when the project followed through with their promised intent.

@quintessence quintessence changed the title Project Application Process Doc section Project Documentation: Application Process Doc section Apr 12, 2023
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 project-docs Documentation about projects on website
Projects
None yet
Development

No branches or pull requests

1 participant