CONTRIBUTING.md 3.0 KB

Contributing to SBPF

sBPF is the first fully independent Solana BPF assembler. It enables users to quickly get started developing sBPF Assembly projects, skipping the heavy build requirements of solana-rust and solana-llvm and translating assembly code directly into SVM-compatible bytecode, handling just the assembler-linker pipeline without the heavy burden of code generation from higher level languages. We aim to provide comprehensive tooling and support for sBPF assembly projects, as well as to improve upon it with additional features to make it composable and user-friendly. Any Pull Request or Issue that does not align with our roadmap will be closed as unplanned.

Vibe Coding

We are humans who write our own tooling because machines have inferior reasoning capabilities and make stupid decisions resulting in inefficient bytecode. We encourage the use of LLMs to help you understand issues, catch bugs and author high quality PRs, however we do not accept PRs that are purely or excessively AI-generated. Trust me when I say that if an LLM could have done it, we wouldn't have wasted our precious time waiting for a community PR.

Communication

As a community-owned project, we encourage open dialog on this repo. Please be respectful and understand that this project has a roadmap that may or may not agree with your own. If you wish to communicate your concerns or thoughts about a part of the project openly, feel free to open a git issue. If you need more instant feedback from a team member, or want to discuss things in more detail, feel free to join our Discord.

Feature Requests

Please open an issue requesting a feature and/or discuss in the Discord.

Features

If you would like to introduce new features to SBPF, Please open an issue first, or join the Discord to discuss. We would hate for you to put in a bunch of work only to have it rejected for being out of line with our current development roadmap!

Bug Reports

To report a bug, please open an issue. Also ensure to separate individual bugs into individual issues. This helps us to track, triage and solve bugs in a more efficient manner.

Bug Fixes

For minor bugs that are solvable in a single-issue PR, feel free to immediately open a PR, referencing an open issue if one already exists. For larger bugs that affect major portions of code or implementation details, it is recommended to open an issue first and ping the team on Discord to discuss.

Nits/Typos

Feel free to directly open a PR.