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

Outline of the content #21

Open
samcunliffe opened this issue Nov 28, 2024 · 1 comment
Open

Outline of the content #21

samcunliffe opened this issue Nov 28, 2024 · 1 comment
Labels
housekeeping Issues about repo organisation, CI, ...

Comments

@samcunliffe
Copy link
Member

We need to figure out how to lay out the content.

@samcunliffe samcunliffe added the housekeeping Issues about repo organisation, CI, ... label Nov 28, 2024
@samcunliffe
Copy link
Member Author

samcunliffe commented Nov 28, 2024

Sections

"Project organisation."

  • Version control
  • Repo organisation
  • Licensing
  • Issues management, board?

"General tooling."

  • Dev workflow PRs
  • CI
  • Testing

"Coding standards."

  • Specific linting
  • Number of tabs vs spaces

Structure

  • Tagging plz (yaml headers)
  • Need good searchability.
  • Should we keep it readable from raw markdown?
    • Yes.

samcunliffe added a commit that referenced this issue Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
housekeeping Issues about repo organisation, CI, ...
Projects
None yet
Development

No branches or pull requests

1 participant