apache / apache/buildstream

Document how/when to use Cython in the codebase

Open
#1,391 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
140
Forks
45
Avg merge
1d 3h
Merged PRs (30d)
6

Description

[See original issue on GitLab](https://gitlab.com/BuildStream/buildstream/-/issues/1391)
In GitLab by [[Gitlab user @BenjaminSchubert]](https://gitlab.com/BenjaminSchubert) on Aug 30, 2020, 11:08

## Summary

[//]: # (Summarize the bug encountered concisely)

Our hacking guide doesn't contain anything about how and when to use Cython in BuildStream,
we should have something about it.

It should at least contain the following:

- how to add a new cython module (where to register it, etc)
- Need a corresponding .pyi file for Mypy type checking
- best practices?

Contributor guide

Open the contributing guide

Research direction

Start with the existing hacking guide and inspect how Cython modules are currently registered in BuildStream. Document how to add a module, the corresponding .pyi file required for Mypy type checking, and any established best practices. The work is done when the guide covers these points clearly for future contributors.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.