Skip to content

Latest commit

 

History

History
executable file
·
41 lines (24 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
41 lines (24 loc) · 2.14 KB

Contributing to Raney-org

First of all, thank you for considering contributing to Raney-org! We appreciate the time and effort you're willing to invest in improving this project. This document will provide you with guidelines and best practices to follow when contributing.

Code of Conduct

Before contributing, please read and follow our Code of Conduct. We expect all contributors to adhere to these guidelines to ensure a respectful and inclusive environment.

How to Contribute

Reporting Bugs

If you find a bug in the project, please follow these steps:

  1. Check the Issues to see if the bug has already been reported. If it has, add any additional information you have to the existing issue.
  2. If the bug hasn't been reported, create a new issue and provide a clear description of the problem, steps to reproduce it, and any relevant information (e.g., screenshots, logs, etc.).

Suggesting Enhancements

If you have an idea for a new feature or improvement, please follow these steps:

  1. Check the Issues to see if the enhancement has already been suggested. If it has, add any additional information you have to the existing issue.
  2. If the enhancement hasn't been suggested, create a new issue and provide a clear description of your idea, including the benefits it would bring to the project.

Pull Requests

When you're ready to contribute code, follow these steps:

  1. Fork the repository and create a new branch for your feature or bugfix.
  2. Make your changes following the project's coding standards and guidelines.
  3. Commit your changes with clear and concise commit messages.
  4. Push your changes to your fork and create a pull request, providing a detailed description of your changes and referencing any related issues.
  5. Make sure your pull request passes any continuous integration checks, and address any feedback or requested changes from the project maintainers.

Development Environment Setup

Provide instructions on how to set up the development environment for your project, including any required dependencies, tools, and configuration steps.

Testing

Explain how contributors can run tests for your project and any specific