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 development guide with tips and tricks #815

Open
3 of 14 tasks
TheJJ opened this issue May 1, 2017 · 1 comment
Open
3 of 14 tasks

Add development guide with tips and tricks #815

TheJJ opened this issue May 1, 2017 · 1 comment
Labels
documentation Involves the project documentation just do it You can start working on this, there should be nothing left to discuss nice new thing ☺ A new feature that was not there before
Projects
documentation

Comments

@TheJJ
Copy link
Member

TheJJ commented May 1, 2017 •
edited by heinezen

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
@TheJJ TheJJ added documentation Involves the project documentation good first issue Suitable for newcomers just do it You can start working on this, there should be nothing left to discuss nice new thing ☺ A new feature that was not there before labels May 1, 2017
@TheJJ TheJJ mentioned this issue Jun 21, 2017
Merged
This was referenced May 25, 2019
Closed
Open
@simonsan simonsan added this to To do in documentation Jun 20, 2019
@simonsan simonsan mentioned this issue Jun 27, 2019
Closed
22 tasks
@heinezen
Copy link
Member

heinezen commented Sep 8, 2023

Te profiling part was added in #1525

@heinezen heinezen removed the good first issue Suitable for newcomers label Sep 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Involves the project documentation just do it You can start working on this, there should be nothing left to discuss nice new thing ☺ A new feature that was not there before
Projects
documentation
  
To do
Milestone
No milestone
Development

No branches or pull requests
2 participants
@TheJJ @heinezen