Skip to content

Latest commit

 

History

History
42 lines (25 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

42 lines (25 loc) · 2.44 KB

Contributing to React Bits

Thank you for considering contributing to React Bits! I appreciate your interest in making this project better.

To ensure a smooth collaboration, please read the following guidelines before getting started.

Issue Tracker

We use the GitHub issue tracker to keep track of bugs, feature requests, and other project-related discussions. Before starting to work on a new feature or bug fix, please check the issue tracker to see if there's an existing issue or discussion related to it. If not, feel free to create a new issue.

Branch Naming

When creating branches for your contributions, please follow the following naming convention:

feat/<feature-name>

For example, if you are working on a feature related to adding a new component, your branch name could be feat/add-new-component. This naming convention helps us to easily track and associate contributions with their respective features.

Pull Requests

We welcome pull requests from everyone. To submit a pull request, please follow these steps:

  1. Fork the repository and create a new branch based on the branch naming convention mentioned above.
  2. Make your changes in the new branch.
  3. Submit a pull request to the main repository's main branch.
  4. Provide a clear and descriptive title for your pull request, along with a detailed description of the changes you have made, and screenshots/videos where possible.
  5. For components updates, ensure that changes are reflected in all related files, such as:
    • react-bits/src/demo/Backgrounds/<ComponentName>Demo.jsx
    • react-bits/src/constants/ExampleConstants.js
    • Preview and Code pages in the documentation, so users can copy the final component code.

Component Dependencies

When updating or adding new components, avoid introducing additional dependencies unless absolutely necessary. Components should remain as agnostic as possible, allowing users to fully customize them to their preferences. Most components in React Bits only use animation libraries and THREE.js at most.

Conclusion

I appreciate your interest in contributing! By following these guidelines, you can help us maintain a healthy and productive open-source community. I value your contributions and look forward to your pull requests!

If you have any questions or need further assistance, please don't hesitate to reach out to us through the issue tracker or other communication channels mentioned in the project's documentation.

Happy contributing!