Skip to content

Latest commit

 

History

History
103 lines (71 loc) · 3.07 KB

CONTRIBUTING.md

File metadata and controls

103 lines (71 loc) · 3.07 KB
Raw

Contributing to Affinity Backend

We are excited that you want to contribute to Affinity Backend! This document will guide you through the contribution process, from reporting issues to submitting pull requests.

Table of Contents

How to Contribute

You can contribute in several ways:

  1. Reporting bugs.
  2. Suggesting new features.
  3. Submitting pull requests with fixes or improvements.
  4. Improving documentation.

We welcome all contributions, but please ensure that your pull requests align with the project's vision and coding standards.

Reporting Bugs

If you find a bug, please open an issue and include:

  • A clear title and description.
  • Steps to reproduce the bug.
  • Expected behavior.
  • Relevant logs, screenshots, or code snippets if available.

Bug Report Example

Title: Incorrect response when updating a resource

Description: When trying to update a resource with valid data, the API returns a 500 error.

Steps to Reproduce:

  Make a PUT request to /api/resource/1 with valid JSON.
  Observe the 500 error.

Expected behavior: The resource should be updated successfully with a 200 status code.

Environment:

  Rust version: 1.XX
  OS: Ubuntu 20.04

Suggesting Features

Feature suggestions are welcome! Please open an issue and provide:

  • A detailed description of the feature.
  • Use cases for the feature.
  • Any screenshots, if applicable.

Feature Request Example

Title: Add pagination to GET /api/resources

Description: Implement pagination to reduce the load when fetching large datasets.

Use cases: This would be useful for endpoints that return a large number of resources, improving performance.

Mockup: (Optional, add any design or mockup if relevant)

Pull Request Process

  1. Fork the repository and create your branch from main:

    git checkout -b feature/new-feature

  2. Commit your changes with clear and descriptive commit messages:

    git commit -m "Add feature: implement pagination"

  3. Push your branch to your forked repository:

    git push origin feature/new-feature

  4. Open a pull request:

  • Ensure your pull request title and description are clear.
  • Reference any related issues or feature requests.
  • Tag reviewers, if necessary.

Code Guidelines

Rust Style Guidelines

  • Follow Rust’s official style guide.
  • Run cargo fmt to format your code.
  • Run cargo clippy to maintain idiomatic code

Commit Message Format

We follow the Conventional Commits specification for writing commit messages:

feat: add new feature to API
fix: resolve issue with database connection
docs: update README with usage instructions

Hacktoberfest & GSSOC

Issues with labels hacktoberfest or gssoc-ext can be picked my multiple contributers. PR which are opened at the earliest and are upto a standard will be merged.