Skip to content

Should we add a developer's guideline section? #43

Open
@martinscooper

Description

@martinscooper

I wonder whether we should add a section that holds specific information about how the Frontend and the Backend are implemented, like a developer guide.

I know there are already cases where it is specified how to do some specific contribution on the backend side, for example, how to add a new Active Learning strategy. But, at the same time, I think that a specific section could be helpful to give developers a quick overview of the system from a technical point of view that also serves as a document that help users to clear up doubts about developing/extending the system. To give a few examples, on the backend it is not mentioned that the backend API is implemented using Flask or that we use typings. Same goes on the frontend side, the developers don't know they will find a ReactJS app which will be (soon) migrated to Typescript auntil they open the source code or that we use Redux extensively to manage the state.

The Carbon design system repo has a Developer Handbook which we could take as a guide.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions