Contributors

Everyone who has committed code to Basalt, ranked by number of commits. The bar under each card shows their share of all commits.

1contributor

13commits

Live from GitLab · updates every 5 minutes

1. #1ZC
   ZeyphrCloudContributor
   13 commits

How to contribute

Bug reports are as welcome as code. Both start on GitLab.

How to report an issue

A good report lets someone else see the problem for themselves. It takes a few minutes and saves a lot of back and forth.

1. Check it isn’t already reported. Look through the open issues, or the full list on GitLab. If you find yours, add a comment with anything new rather than opening another.

2. Note your versions. Run git rev-parse --short HEAD in your Basalt folder to get the commit you’re on. Also note the Bedrock client version and device players use, and the operating system Basalt runs on.

3. Reproduce it with more logging. Start Basalt with debug logging, make the problem happen again and keep the log:

   RUST_LOG=info,basalt=debug ./target/release/basalt

4. Open the issue. Go to New issue on GitLab and fill in this outline:

   ## What happened
   Players fall through the floor after joining the nether.
   
   ## What should happen
   They land on the netherrack like in vanilla.
   
   ## Steps to reproduce
   1. Join the server in survival.
   2. Build a portal and go through it.
   
   ## Versions
   Basalt commit: 9ac345a
   Bedrock client: 1.26.60 on Windows
   Server OS: Ubuntu 24.04
   
   ## Log and settings
   (paste the relevant part of the log, and any basalt.toml settings you changed)

5. Keep security problems private. If the issue lets someone crash the server, get around anti-cheat or reach other players’ data, tick This issue is confidential before submitting, so only maintainers can see it.

How to open a pull request

1. Talk about big changes first. For anything beyond a small fix, open an issue or ask on Discord so nobody spends time on something that won’t fit.

2. Fork and clone. Press Fork on the repository page, then clone your fork and create a branch from main:

   git clone https://gitlab.com/<your-name>/basalt-bds-software.git
   cd basalt-bds-software
   git checkout -b feat/composters

3. Make your change, then check it. Format the code with the repository’s rustfmt.toml, run the tests and make sure the server still builds:

   cargo fmt
   cargo test
   cargo build --release -p basalt-server

4. Write commit messages as type(what changed). Use one of feat, fix, perf, docs, refactor, test or chore, for example fix(hopper cooldown). The commit cards on this page take their badge from that type.

5. Push and open the pull request. Push your branch, then follow the Create merge request link GitLab prints, or open New merge request. Set the target branch to main, and say what the change does, why, and how you tested it.

6. Follow the review. Reviewers comment on the merge request. Push more commits to the same branch to answer them; the merge request updates by itself.

Not sure where to start?Ask on Discord. Someone can point you at a good first change.

Join the Discord