Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

29 lines (18 loc) · 1.24 KB
Raw

Contributing Guide

Thank you for considering contributing to bos-workspace! Here are some guidelines to help you get started.

Getting Started

To contribute to bos-workspace, follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Make your changes locally, see the examples for how to do this.
  4. Test your changes to ensure they work as expected.
  5. Commit your changes with descriptive commit messages. We like Semantic Commit Messages.
  6. Push your changes to your fork on GitHub.
  7. Create a pull request to the main repository.

Code Style

Please follow the existing code style and conventions used in the project.

Testing

This repository uses jest unit tests, which can be found in /tests. Ensure that your changes include appropriate tests and that existing tests pass.

Submitting Issues

If you encounter any issues or have feature requests, please submit them through GitHub issues. Include as much detail as possible to help us understand and address the problem efficiently.

Thank you for your interest in contributing to bos-workspace! Your contributions are greatly appreciated.