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

Rewrite README / document where development resources are #43

Open
20 tasks
Razish opened this issue Apr 19, 2020 · 0 comments
Open
20 tasks

Rewrite README / document where development resources are #43

Razish opened this issue Apr 19, 2020 · 0 comments
Assignees
@Yberion
Labels
C: usability category: usability M: docs module: documentation P: high priority: high S: open status: open
Projects
Tracking

Comments

@Razish
Copy link
Contributor

Razish commented Apr 19, 2020 •
edited

  • project description - include a link to upstream (JACoders/OpenJK) README.md
  • project status
    • e.g. playability, target audience
    • CI / analysis / coverage tools (sonarcloud, etc)
    • platform support (OS: windows, mac, linux, bsd || CPU: x86, x64, ARM)
  • links
    • discord - the insane asylum
    • repo list
    • plans.md - still migrating to issue tracker, don't expose
    • changelog
  • contribution guide: issue tracker, how to use labels (developers and players)
  • release installation instructions (client, server)
  • developer installation instructions
    • repo checkout, toolset project generation
    • asset checkout, configuration
    • path / IDE / debugger configuration instructions
      • utilising [basepath:release, cdpath:staging, cwd:development, homepath:profile]
    • contribution guide: code style, commit rules, rule enforcement (pre/post build steps)
    • packaging/release instructions
    • CI / analysis / coverage integration overview
  • credits/contributors
@Razish Razish added M: docs module: documentation P: high priority: high S: open status: open C: usability category: usability labels Apr 19, 2020
@Yberion Yberion self-assigned this Apr 19, 2020
@Razish Razish added this to Priority in Tracking Feb 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Yberion Yberion

Labels
C: usability category: usability M: docs module: documentation P: high priority: high S: open status: open
Projects
Tracking
Priority
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Razish @Yberion