Skip to content

Latest commit

 

History

History
42 lines (25 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

42 lines (25 loc) · 2.25 KB

Contributing to BgLib

We're thrilled that you're interested in contributing to BgLib! Join our vibrant community of developers and designers who share a passion for crafting stunning backgrounds.

The Benefits of Contributing

By contributing to BgLib, you'll be instrumental in shaping a comprehensive library of high-quality backgrounds that can be leveraged by developers and designers globally. This opportunity also allows you to:

  • Learn from fellow contributors and industry experts
  • Receive constructive feedback on your work
  • Enhance your portfolio with meaningful projects

Contribution Guidelines

To ensure a smooth collaboration process, please follow these steps:

  1. Fork the BgLib repository: Duplicate the BgLib repository within your GitHub account.
  2. Create a feature branch: Establish a new branch specifically for your feature or fix. This enables us to track your changes efficiently and facilitates the merging process.
  3. Implement your changes: Introduce new gradients or modify existing ones, adhering to our coding standards and best practices.
  4. Verify your changes: Thoroughly test your modifications to ensure they function as intended.
  5. Commit your changes: Document your changes with a clear, descriptive commit message.
  6. Push your changes: Upload your changes to your forked repository.
  7. Submit a pull request: Initiate a pull request to integrate your changes into the main BgLib repository.

Coding Standards

We adhere to industry-standard coding practices and utilize Prettier for code formatting. Ensure your code aligns with the existing codebase for consistency.

Licensing

By contributing to BgLib, you agree to license your contributions under the MIT License.

Contribution Opportunities

We welcome contributions in the form of new gradients, enhancements to existing gradients, and bug fixes. If you have a concept for a new gradient or a suggestion for improving an existing one, please share it with us!

Support and Resources

If you require assistance or have questions, don't hesitate to reach out. You can connect with us through GitHub or our website.

Thank you for considering contributing to BgLib! We eagerly anticipate your contributions and look forward to collaborating with you.