Contributing Code
Proposing code changes has 3 main steps:
- Setting up your development environment
- Pick an issue to work on
- Write code and submitting for review
Setting up your development environment
Before starting
Make sure Rust is installed with Rustup.rs.
Have an account on GitHub: this is where you'll find the source code for Fish Fight.
Getting the source code
Fish Fight uses git as its established choice of version control. You'll be using it to clone, track, and manage the source code locally on your machine.
To get a copy of the code, you'll first need to fork the repository. The GitHub repository for Fight Fight is available here. This will allow you to make changes to the project without affecting the original one.
Once you've forked the Fish Fight repository, you can now clone it:
git clone https://github.com/fishfolk/jumpy.git
It's also possible to clone the repo using SSH or GitHub CLI. For more information on how to do this, see the official GitHub documentation.
Depending on your connection, the clone can take around 1 minute.
By the end of this step, you should have successfully forked and downloaded a clone of Fish Fight on your machine.
Build and run
You can now build your forked copy of Fish Fight:
cargo build
This process should take about a minute or two depending on your machine. You can also build and run the game with a single command:
cargo run
Finding a good first issue
Now that you can build and run Fish Fight source code, let's find something to work on! We recommend all newcomers start with our Development Tracks. You can also browse project's issues list and pick something with a help wanted label. In general, you can comment on an issue expressing interest and someone will assign it to you.
Additionally, if there's a track or issue you're particularly interested in, but you don't know where to start, feel free to reach out to the Fish Fight Discord community with your questions and someone should reach out shortly!
Write code and submitting for review
In general, Fish Fight uses a branch-based workflow (or GitHub flow) for submitting changes to the project.
Create a new branch
You'll want to create a new branch off main:
git checkout -b <branch_name> main
You'll replace <branch-name> with something short and descriptive. For example, if you're adding a new item to Fish Fight, your branch name might look like this:
git checkout -b add_new_weapon main
Commit your changes
Once you've made the desired changes to the code and you're ready for someone on the Fish Fight team to review, you need to commit your work. But first, we have to run a few commands to ensure the code you're submitting is properly formatted:
cargo clippy -- -W clippy::correctness -D warningscargo fmt
Now we can start committing your work. First, stage your changes: git add
Now commit. It's always good practice to provide a short message that details what the changes are. For example: git commit -m "Add a new weapon"
Submitting for review
You can now start submitting your work for review. First, push your changes:
git push
This will create a new branch on your forked copy of Fish Fight. You can then proceed making a pull request. This is how the Fish Fight team will review and provide feedback on your work.