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.

Sign up for GitHub

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

Jump to bottom

Add maintainer information #260

Open
1 of 2 tasks
cschwan opened this issue Feb 10, 2024 · 0 comments
Open
1 of 2 tasks

Add maintainer information #260

cschwan opened this issue Feb 10, 2024 · 0 comments
Assignees
@cschwan @felixhekhorn @alecandido @Radonirinaunimi
Labels
documentation Improvements or additions to documentation

Comments

@cschwan
Copy link
Contributor

cschwan commented Feb 10, 2024

To guarantee PineAPPL's long-term maintainability we should add documentation

  • explaining the repository structure with a detailed account of all top-level files and associated documentation (added in commit aced987)
  • each crate should document the overall code structure with the most important structs and present a short guide where to start reading
@cschwan cschwan added the documentation Improvements or additions to documentation label Feb 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cschwan cschwan

@felixhekhorn felixhekhorn

@alecandido alecandido

@Radonirinaunimi Radonirinaunimi

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@cschwan @felixhekhorn @alecandido @Radonirinaunimi