Contributing to basishacks

Welcome

Thank you for your interest in contributing to basishacks, the official platform for the BIBS-C Network Hackathon. This document outlines the expectations and processes for any person wishing to contribute code, report issues, or otherwise help improve the project.

Commit Guidelines

All contributions arrive through pull requests to the basishacks-r2 repository . Follow these guidelines when preparing your changes:

• Use conventional commits. Prefix each commit message with a type such as feat , fix , docs , test , refactor , chore , or style . Adhere to the format type(scope): description .
• Keep changes focused. Each commit ought to represent a single logical change. Avoid bundling unrelated modifications within the same commit.
• Write meaningful descriptions. The body of the commit message should explain why the change was made, not merely what was changed.
• Run the test suite. Execute bun run test and confirm that all tests pass before submitting a pull request. Also run bun run format to ensure code style compliance.
• Refrain from committing secrets. Never commit API keys, tokens, passwords, or other sensitive credentials. All secrets must be loaded from environment variables.
• Rebase onto main. Before opening a pull request, rebase the working branch onto the latest main and resolve any conflicts.

Reporting Security Issues

If you discover a security vulnerability or any other issue that could compromise the integrity of the platform or its users, disclose it privately. Do not file a public GitHub issue or discuss the matter in public forums. Public disclosure of a vulnerability before a fix is deployed places every user of the platform at risk, and any person who discloses such information publicly may be considered complicit in subsequent misuse of that vulnerability by third parties.

If you possess the ability and the willingness to do so, we encourage you to fix the issue yourself: fork the repository, implement the correction, commit it, and open a pull request. We will review it and decide whether to merge it as promptly as possible. To protect the integrity of the fix during the review window, you may choose to obfuscate the correction by including unrelated boilerplate changes and by refraining from mentioning the vulnerability explicitly in the pull request description, as pull requests are publicly visible.

To report a security concern, send an email or a Teams message to the BIBS-C Developers' Club at [email protected] . Include a detailed description of the issue, steps to reproduce it, and any relevant supporting material.

We acknowledge receipt usually within 48 hours and work to address the issue as quickly as possible. Depending on the severity and impact of the report, we may offer a discretionary reward, though no guarantee of compensation is made in advance. If you indicate in your correspondence whether you wish to be publicly mentioned or thanked after the hackathon season concludes, we will respect that choice.

Responsible Disclosure

We ask that you act in good faith and refrain from exploiting any vulnerability you discover. Unauthorized access, data exfiltration, service disruption, or any other malicious activity is not tolerated.

We maintain full logging and audit trails across the platform. In the event that a person is found to have exploited a vulnerability rather than reported it, we pursue all available remedies, which may include reporting the incident to school administration or further authorities depending on the severity of the issue. We possess the capability to identify and trace such activity, and we hold accountable any person who chooses to abuse the system rather than assist in its protection.

Code of Conduct

All contributors are expected to adhere to the principles of respect, integrity, and collaboration. Harassment, discrimination, or any form of unprofessional behavior is not permitted. By participating in this project, you agree to uphold these standards.