Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 1.99 KB
Raw

Contributing to OPLF

We appreciate your interest in contributing to OPLF! Your contributions are vital to the success and growth of this project. The following guidelines will help you get started and ensure a smooth contribution process.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please read it before contributing.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork to your local machine.
  3. Create a new branch for your changes. Use a descriptive branch name, such as fix-issue-123 or add-feature-xyz.
  4. Make your changes in the new branch, following the project's coding style and conventions.
  5. Commit your changes with a descriptive commit message.
  6. Push your changes to your fork on GitHub.
  7. Open a pull request against the main branch of the original repository.

Pull Request Guidelines

  • Keep your pull requests focused and limited to a single issue or feature.
  • If your changes involve significant modifications or additions, open an issue first to discuss them with the maintainers.
  • Include a clear description of the changes in your pull request, as well as any relevant issue numbers.
  • Update the documentation and tests, if necessary, to reflect your changes.

Reporting Issues

When reporting issues, please provide as much information as possible, including:

  • A clear and descriptive title
  • A detailed description of the issue, including steps to reproduce it if possible
  • Any error messages or logs related to the issue

Code Style and Conventions

Follow the coding style and conventions used in the existing codebase. This may include:

  • Indentation and formatting
  • Naming conventions for variables, functions, and classes
  • Commenting and documentation

Testing

Make sure to test your changes before submitting a pull request. This may involve running unit tests, integration tests, or manual tests, depending on the scope of your changes.

Thank you for your contributions!