Skip to content

Latest commit

 

History

History
93 lines (62 loc) · 4.23 KB

CONTRIBUTING.md

File metadata and controls

93 lines (62 loc) · 4.23 KB

Contributing to BARK - BLINKS Web UI

First off, thank you for considering contributing to the BARK - BLINKS Web UI project! It's people like you that make BARK - BLINKS such a great tool. We welcome contributions from the community and are grateful for any time, effort, and expertise you choose to dedicate to improving this project.

The following is a set of guidelines for contributing to BARK - BLINKS Web UI. 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

  1. Code of Conduct
  2. Getting Started
  3. How Can I Contribute?
  4. Style Guides
  5. Commit Messages
  6. Pull Requests
  7. Additional Notes

Code of Conduct

This project and everyone participating in it is governed by the BARK - BLINKS Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to conduct@barkprotocol.com.

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork locally
  3. Set up the development environment as described in the README.md
  4. Create a new branch for your contribution
  5. Make your changes
  6. Push your changes to your fork on GitHub
  7. Submit a pull request to the main repository

How Can I Contribute?

Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues
  • If you're unable to find an open issue addressing the problem, open a new one
  • Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring

Suggesting Enhancements

  • Open a new issue with your suggestion
  • Provide a clear and detailed explanation of the feature you want to see
  • Include any relevant mockups or examples if applicable

Your First Code Contribution

  • Look for issues labeled "good first issue" or "help wanted"
  • If you're not sure where to start, ask for help in the issue comments

Pull Requests

  1. Follow all instructions in the template
  2. Follow the style guides
  3. After you submit your pull request, verify that all status checks are passing

Style Guides

JavaScript Style Guide

We use ESLint and Prettier to enforce a consistent coding style. Please ensure your code adheres to the rules defined in our .eslintrc.js and .prettierrc files.

CSS Style Guide

We use Tailwind CSS for styling. Please follow the Tailwind CSS best practices and use utility classes whenever possible.

Commit Messages

  • 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

Pull Requests

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build
  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters
  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent
  4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

  • bug - Issues that are bugs
  • enhancement - Issues that are feature requests
  • documentation - Issues or pull requests related to documentation
  • good first issue - Good for newcomers
  • help wanted - Extra attention is needed
  • question - Further information is requested

Thank you for contributing to BARK - BLINKS Web UI!