SFTtech / SFTtech/openage

Add development guide with tips and tricks

Open
#815 1 comment 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation just do it nice new thing ☺
Dominant language
Python
Stars
14.4k
Forks
1.3k
PR merge metrics
No merged PRs in 30d

Description

We could use a simple guide file for new contributors. We have that for git, but not for Python and C++.

  • usage of asdf to break the CI build intentionally
  • how to add a new feature (e.g. adding a demo so you have a "new" main() function)
  • common C++ mistakes (let's see if we can get those in under 100MiB :P)
  • redirection to the code_style
  • how to profile (python, cython, c++)
    • python (openage.util.profiler.Profiler)
    • cython (activate profiling in cython code, then start profiling with the openage.util.profiler.Profiler)
    • C++ (hit F12 to start and stop profiling, then you'll get a report-PDF)
  • summary of
    • useful openage functions (incl redirection to testing/demo docs and others)
      • ENSURE macro
      • log system introduction
      • error::Error and MSG usage
      • libopenage/util/fslike introduction
      • libopenage/util/timer
      • libopenage/util/strings
    • make people aware of existing custom datastructures
      • PairingHeap
      • ...
    • how to add cython files
    • how to add c++ files
    • how to add python files

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the existing git guide, the code_style documentation, and the testing/demo docs referenced in the issue. Use those as the structure for a contributor development guide covering the unchecked asdf, feature, C++, profiling, utility, data-structure, and file-creation topics. Done means the guide addresses the listed items and links to the existing profiling and style guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, python
Domain
developer-experience, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.