Skip to content

Improve guide on working with the Paper source code #521

Open
@Strokkur424

Description

@Strokkur424

I think it could be nice to include more information on how to work with Paper's source code. This would include not only information for contributors, kinda how we already have the Events page, but also information regarding how to correctly fork Paper (use paperweight to do so) and maintain your own fork could be part of that category.

The following pages are what came to mind first. I wish to ask for anybody to suggest more pages or changes to these:

Page name Page content
Contributing to Paper How to open a PR, what to watch out for, basically CONTRIBUTING.md in the main repo
Styling guidelines Perhaps a dedicated page to certain guidelines, like imports, // Paper comments, and similar
Forking Paper A page explaining how to create and maintain your own fork of Paper using paperweight

Opening this as an issue first, since I want to have some input whether anybody thinks this is really needed in the first place. We already have this one Events contribution page without much context around it, so I think it could be good to extend onto that.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions