Skip to content

Latest commit

 

History

History
62 lines (45 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

62 lines (45 loc) · 2.47 KB

Contributing to StrObj

We welcome contributions to the StrObj project and are grateful for every kind of help provided. This document provides guidelines for contributing to the StrObj library.

Table of Contents

Code of Conduct

This project adheres to a code of conduct. By participating, you are expected to uphold this code. Please read Code of Conduct for details.

Getting Started

Before you begin contributing to StrObj, please take a moment to:

  • Familiarize yourself with the Code of Conduct.
  • Read the documentation and understand the library's functionality.

Submitting Changes

  1. Fork the Repository

    • Navigate to the StrObj repository on GitHub and click the "Fork" button.

  2. Clone the Fork

    • Clone your forked repository to your local machine.

  3. Create a New Branch

    • Create a branch for your changes: git checkout -b feature/my-new-feature.

  4. Make Your Changes

    • Implement your feature or bug fix.

  5. Commit Your Changes

    • Commit your changes with a clear commit message.

  6. Push to the Branch

    • Push your changes to your GitHub repository.

  7. Create a Pull Request

    • Open a pull request in the original StrObj repository.

Coding Standards

  • Follow the PSR-12 coding standards.
  • Write clear, understandable, and well-documented code.

Pull Request Process

  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • Update the README.md with details of changes to the interface, including new environment variables, exposed ports, useful file locations, and container parameters.
  • Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent.

Reporting Bugs

  • Use GitHub Issues to report bugs.
  • Clearly describe the issue, including steps to reproduce the bug.
  • A code sample or an executable test case demonstrating the problem will help greatly.

Feature Requests

  • Open an issue with a detailed explanation of the feature you would like to see, and how it would benefit users.

Thank you for your interest in contributing to StrObj!