Skip to content

Latest commit

 

History

History
91 lines (58 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

91 lines (58 loc) · 2.78 KB

Contributing to RealWear Collaborate

Thank you for your interest in contributing to RealWear Collaborate! We welcome contributions of all kinds, including bug fixes, new features, documentation improvements, and more. By contributing, you help make this project better for everyone.

How to Contribute

1. Fork the Repository

Start by forking this repository to your own GitHub account. This allows you to make changes to the codebase without affecting the original project.

2. Create a Branch

Create a new branch for your contribution. Use a descriptive name that reflects the purpose of your changes, such as fix-bug-123 or add-new-feature.

git checkout -b my-feature-branch

3. Make Your Changes

Make your changes in your branch. Ensure your code adheres to the project's style guide and conventions. Don’t forget to add or update tests if your changes affect functionality.

4. Test Your Changes

Run the tests locally to make sure everything works as expected.

yarn test

5. Submit a Pull Request (PR)

Once you’re happy with your changes:

  1. Push your branch to your forked repository.
  2. Open a Pull Request (PR) against the main branch of this repository.

In your PR description:

  • Clearly explain the purpose of the changes.
  • Reference any relevant issues (e.g., Fixes #123).
  • Include testing instructions, if applicable.

We encourage smaller, focused PRs rather than large, sweeping changes.

Contribution Guidelines

To maintain a high-quality codebase and ensure smooth collaboration, please follow these guidelines:

  1. Adhere to the Coding Standards
    Follow the project's coding style and conventions. Consistent code helps everyone understand and maintain the project. Run yarn lint against the project as a quick sanity check.

  2. Write Clear Commit Messages
    Use meaningful, descriptive commit messages that explain your changes.

  3. Be Respectful and Collaborative
    Engage with other contributors and maintainers in a respectful and professional manner. We're all here to improve the project!

What Happens Next?

After you submit a PR:

  1. Review Process: A maintainer will review your changes. They may suggest improvements or request clarifications.
  2. Approval and Merge: Once the PR meets all requirements and passes review, it will be merged into the main branch.
  3. Feedback: If your PR is not accepted, we’ll provide constructive feedback so you can address any issues.

Questions or Suggestions?

If you have any questions about contributing or suggestions for improvements, feel free to open a discussion or create an issue. We’re here to help!

Thank you for helping make RealWear Collaborate a better project. Your contributions are greatly appreciated!