Here are some steps to guide you through the process of contributing to this repository:
Before you start working on a contribution, please take a moment to look through the open issues in the issue tracker for this project. This will give you an idea of what kind of work is currently being planned or is in progress.
Before you can start making changes, you'll need to fork the repository and clone it to your local machine. This can be done via the GitHub website or the GitHub Desktop application. Here are the steps:
- Click the "Fork" button at the top-right of this page to create a copy of this project in your GitHub account.
- Clone the repository to your local machine. You can do this by clicking the "Code" button on the
GitHub website and copying the URL. Then open a terminal on your local machine and type
git clone [the URL you copied].
It's a good practice to create a new branch for each contribution you make. This keeps your changes
organized and separated from the main project, which can make the process of reviewing and merging
your changes easier. You can create a new branch by using the command
git checkout -b [branch-name].
Once you have set up your local repository and created a new branch, you can start making changes. Be sure to follow the coding standards and guidelines used in the rest of the project.
Before you open a pull request, please run ./run-checks.sh all. This
will ensure that your changes are in line with our project's standards and guidelines. You can run
this script by opening a terminal, navigating to your local project directory, and typing
./run-checks.
Note that under the hood run-checks runs the cargo xtask validate command which is powered by
the tracel-xtask crate. It is recommended to get familiar with
it as it provides a wide variety of commands to help you work with the code base.
Format and lint errors can often be fixed automatically using the command cargo xtask fix all.
After you've made your changes and run the pre-pull request script, you're ready to submit a pull request. This can be done through the GitHub website or the GitHub Desktop application.
When submitting your pull request, please provide a brief description of the changes you've made and the issue or issues that your changes address.
We believe in clean and efficient code. While we don't enforce strict coding guidelines, we trust
and use tools like cargo fmt and cargo clippy to maintain code quality. These are integrated
into our cargo xtask validate command, ensuring consistency across our codebase.
In Rust, the expect() function is a crucial tool for handling errors. However, the power of
expect() lies in its ability to convey clear, actionable messages. When you use expect(), your
message should describe the successful outcome of the function rather than focusing on the error.
Here's a helpful tip from the Rust documentation:
Think of expect() messages as guidelines for future you and other developers. Frame them with the word “should” like “The ENV variable should be set by X function” or “The binary should be accessible and executable by the current user.”
This approach ensures that expect() messages are informative and aligned with the intended
function outcomes, making debugging and maintenance more straightforward for everyone.
Integration tests should be in a directory called tests
besides the src directory of a crate. Per convention, they must be implemented in files whose name start with the test_ prefix.
If you have any questions and would like to get in touch with us, please feel free to join our
discord server and post in the Infrastructure Development channel:
