Skip to main content
First off, thank you for considering contributing to a1facts! It’s people like you that make this project great. Please read through this guide to learn how you can get involved.

​
How to Contribute

We welcome contributions in several forms. Here are a few ways you can help:

Reporting Bugs

If you find a bug, please open an issue on our GitHub repository. Provide as much information as possible, including a clear title, a detailed description, and steps to reproduce the issue.

Suggesting Enhancements

If you have an idea for a new feature or an improvement, open an issue to discuss it. This helps us coordinate our efforts and prevent duplication of work.

Submitting Pull Requests

If you’d like to contribute code, we’d love to see your pull requests. Follow the steps below to get started with development.

​
Development Workflow

1

Set Up Your Development Environment

To get started, you’ll need to set up a local development environment. Follow the instructions in the Quickstart guide to clone the repository and install the dependencies.
2

Create a New Branch

Create a new branch for your feature or bug fix. Use a descriptive name that summarizes your changes.
git checkout -b feature/my-new-feature
3

Make Your Changes

Make your changes to the codebase and commit them with a clear and descriptive commit message.
git commit -m "feat: Add my new feature"
4

Submit a Pull Request

Push your changes to your fork and open a pull request to the main repository. Please provide a detailed description of your changes in the pull request.
git push origin feature/my-new-feature
Contributor License Agreement (CLA): By submitting a pull request to this repository, you agree to assign the copyright of your contribution to the project owner. This allows us to license the project and your contributions appropriately. If you have any questions, please reach out to us.