it/docs

Software

Last updated:

The IT chapter maintains a lot of different software systems made to ease operations. Most software can be found on the chapter's GitHub organization.

Generally, most chapter software is the responsibility of init, though some systems relating to the chapter hall are managed by SMN, and software specific to a committee often being maintained by the committee itself. If you are unsure of who is responsible for a project, you can ask init about it.

All chapter members are more than welcome to contribute to the various systems we develop and maintain. Software development is fun, and we encourage everyone to get involved.

Projects

Every project has different needs and requirements, so please consult the repository's CONTRIBUTING.md if there is one. If not, do not hesitate to ask the repository responsible or, if unknown, init. Projects should all have someone who is head responsible for it's development and maintenance, but if this is not evidently the case please contact init.

Projects developed in or for the chapter should strive to remain open-source and under a permissive license. This ensures that we both give back to the open-source community, and make it easier for future generations to work on our systems.

Documenting new projects

If you want to start a new project, see Starting a Project for the specific details. This section will focus on how the project should be documented after being created.

OpenAPI

OpenAPI is a specification for describing RESTful APIs. It allows developers to define the structure of their API, including the endpoints, request/response formats, and authentication methods. By using OpenAPI, we can generate client libraries, documentation, and other tools that make it easier for developers to work with our systems.

Some resources for learning more about OpenAPI include:

On this page