Skip to content

Latest commit

 

History

History
112 lines (69 loc) · 4.19 KB

CONTRIBUTING.md

File metadata and controls

112 lines (69 loc) · 4.19 KB
Raw

Contributing to OpenBridge-webcomponent library

First off, thank you for considering contributing to OpenBridge-webcomponent library. It's people like you that make OpenBridge-webcomponent such a great tool.

Code of Conduct

The OpenBridge-webcomponents has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for OpenBridge-webcomponents. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻, and find related reports 🔎.

Before Submitting A Bug Report

  • Check the documentation for tips on fixing the problem.
  • Check if the issue has already been reported.
  • If you're unable to find an open issue addressing the problem, open a new one.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. Create an issue.

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as much detail as possible.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.

Contributing to the Codebase

Read through the implementation guidelines

A good place to start is to read through the implementation guidelines in the IMPLEMENTATION_GUIDELINES.md file.

Fork the Repository

Before making changes, you should fork the project's repository to your own account. This allows you to freely experiment with your changes without affecting the original project.

Clone Your Fork

After forking, clone your fork to your local machine to begin making changes:

git clone https://github.com/Ocean-Industries-Concept-Lab/openbridge-webcomponents.git
cd openbridge-webcomponents

Create a Branch

Create a new branch for your work:

git checkout -b your-branch-name

Make Your Changes

With your branch created, you can now make your changes. Be sure to adhere to the project's coding standards and guidelines.

Commit Your Changes

Once you've made your changes, add them to the branch. Use Conventional Commits:

git add .
git commit -m "feat: Add some feature"

Push to Your Fork

Push your changes to your fork on GitHub:

git push origin your-branch-name

Submit a Pull Request

Go to the repository on GitHub, and you'll see a prompt to submit a pull request. Fill in the necessary details and submit.

Additional Ways to Contribute

  • Reviewing pull requests
  • Writing documentation
  • Participating in discussions

Pull Request Guidelines

  • Include screenshots and animated GIFs in your pull request whenever possible.
  • Follow the coding conventions of the project.
  • Document new code based on the Documentation Styleguide.
  • End all files with a newline.

Styleguides

Git Commit Messages

  • Use Conventional Commits syntax.
  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally after the first line.

Getting Help

If you have any question start by contacting us on our slack channel. Click here to join the slack workspace, and join the #openbridge-webcomponents channel.

Thank you for contributing to OpenBridge-webcomponents!