Contributing to GraphArch

You’re very welcome to contribute to GraphArch! Thank you for considering contributing to GraphArch!

We appreciate your interest in improving this project, and we’re excited to work with you. This document provides guidelines to help you get started with contributing to GraphArch.

How Can You Contribute?

There are several ways you can contribute to GraphArch:

  1. Report Bugs:

    If you come across a bug, please create an issue describing the problem and how to reproduce it using GitHub Issues.

  2. Suggest New Features:

    If you have an idea for a new feature or an enhancement, feel free to open an issue to discuss it using GitHub Issues.

  3. Code Contributions:

    You can contribute to the development of GraphArch by fixing bugs, adding new features, or improving the documentation.

    See Contribute Code for more details.

  4. Improve Documentation:

    Documentation is key to making GraphArch accessible. You can help by improving existing documentation or writing new guides.

Contributor License Agreement (CLA)

To contribute to this project, you must sign the Contributor License Agreement (CLA). We use CLA assistant to streamline this process. You will be prompted to sign the CLA when you make your first contribution.

CLA assistant

Getting Started (as a developer)

Create an Issue

Before creating a branch, please create an issue describing your intent. This helps the community understand the purpose of your work and allows for discussion and feedback before you begin implementation.

Fork the Repository

Start by forking the repository to your GitHub account.

Clone the Repository

Clone the forked repository to your local machine.

git clone https://github.com/ekgf/grapharg.git
cd grapharch

Create a Branch

Once your issue has been approved, create a new branch for your feature or bug fix.

git switch -c features/your-feature-name

Make Your Changes

Implement your changes, make sure they are well-tested, and follow the coding standards of the project.

Commit Your Changes

See Git Commit Notes for more details.

Create a Pull Request

Go to the original repository on GitHub and open a pull request from your forked repository. Describe your changes thoroughly in the pull request description.

Guidelines

Coding Standards

Please ensure your code follows best practices and is formatted correctly. rustfmt must be used before committing, and this will be verified by a GitHub Actions workflow, just like the Conventional Commits check.

Testing

Ensure that you write tests for new features or bug fixes. Use cargo test to run all tests and verify that everything works as expected.

Code of Conduct

We follow the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report any behavior that violates this code to info@ekgf.org.

Issues and Feature Requests

If you encounter any issues, have questions — or have feature requests — please open an issue on the GitHub issues page.

Contact

If you have any questions, feel free to reach out at info@ekgf.org.

Thank you for helping us make GraphArch a great tool for the community!

Table of contents