Skip to content

Latest commit

 

History

History
80 lines (52 loc) · 3.07 KB

CONTRIBUTING.md

File metadata and controls

80 lines (52 loc) · 3.07 KB

Contributing to OPNHUB

First off, thanks for taking the time to contribute! 🎉 The following is a set of guidelines for contributing to OPNHUB. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

How Can I Contribute?

Reporting Bugs

If you find a bug, please open an issue and provide the following information:

  • A clear and descriptive title for the issue.
  • A description of the bug, including steps to reproduce it.
  • Any logs, screenshots, or additional context that may help us understand the issue.

Suggesting Enhancements

Enhancements can include new features, refactoring existing code, or improving documentation. When suggesting an enhancement:

  • Open an issue with a clear title and description of the enhancement.
  • Explain why the enhancement would be useful.
  • Include any relevant code snippets or ideas on how the enhancement could be implemented.

Submitting Pull Requests

Before submitting a pull request (PR):

  1. Ensure your work follows the project’s Style Guides.
  2. Test your changes thoroughly.
  3. If your PR addresses an issue, reference the issue number in your commit message (e.g., Fixes #123).

To submit a pull request:

  1. Fork the repository and create your branch from main.
  2. Write clear and descriptive commit messages.
  3. Submit your pull request, providing a detailed explanation of your changes.

Style Guides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Limit the first line to 50 characters or less.
  • Include a detailed description of the change in the following lines if necessary.

Code Style

  • Follow the existing code style of the project.
  • Use comments to explain complex code.

Additional Notes

Issue and Pull Request Labels

We use labels to categorize issues and pull requests. Here are some of the labels we use:

  • bug: Something isn't working.
  • enhancement: New feature or request.
  • help: Extra attention is needed.
  • good first issue: Suitable for someone new to open-source.

Thanks again for your contribution! 🙌