Skip to content

Latest commit

 

History

History
64 lines (36 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

64 lines (36 loc) · 2.34 KB
Raw

Contribution Policy

Last Updated: October 26th, 2023

Introduction

Welcome to Bruno! This document provides guidelines for contributing to the project. By participating in this project, you agree to abide by its terms.

How to Contribute

Contributions to Bruno can be made in various forms. Some of the ways you can contribute are:

  1. Submitting bug reports and feature requests
  2. Writing code for new features or bug fixes
  3. Improving documentation

Getting Started

  1. Fork and Clone: Fork the project on GitHub and then clone your fork locally.
  2. Create a Branch: Create a new branch in your local repository for each significant change.
  3. Commit Changes: Make your changes in your branch. Remember to keep your commits small and focused; they should explain why you made the change, not just what changed.

Code Contributions

When contributing code, please keep the following in mind:

  1. Code Style: Maintain the chosen technology stack. Write code in a similar style as the existing code, including headers and comments.
  2. Testing: If present, add unit tests or update existing tests as necessary.
  3. Documentation: Update the documentation, the README, or other relevant documentation accordingly.
  4. Attribution: Each code file includes a list of authors. Consider adding your name to this list if you make modifications. While this is not mandatory, it helps acknowledge your contributions.

Submitting a Pull Request

Before submitting a Pull Request (PR), ensure the following:

  1. You have merged the latest changes from the main branch into your branch.
  2. Your code compiles and runs without any errors.
  3. You have added or updated tests as necessary.
  4. You have updated the documentation if required.
  5. The PR title and description clearly describe the changes you are proposing.

Review Process

Once you submit a PR, the project maintainers will review your changes. The review process might include suggestions for improvements or requests for changes.

Reporting Issues

When reporting issues, please provide:

  1. A clear and descriptive title.
  2. A detailed description of the issue.
  3. Steps to reproduce the issue.
  4. Any relevant logs or error messages.

Questions or Suggestions?

If you have questions or suggestions about the contribution process, feel free to reach out to the maintainers or open an issue for discussion.