Skip to content

Latest commit

 

History

History
78 lines (51 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

78 lines (51 loc) · 2.33 KB
Raw

BoomCam - Web-Based Photo and Video Editor for Social Media

Welcome to BoomCam! Thank you for considering contributing to our open-source project. We appreciate your time and effort to help make BoomCam even better. Whether you want to fix a bug, add a new feature, or improve documentation, your contributions are highly valued.

Getting Started

Before you start contributing, please make sure you have the following prerequisites:

Fork the Repository

To contribute to BoomCam, fork the repository to your GitHub account. You can do this by clicking the "Fork" button on the top right corner of the repository page.

Clone the Repository

Clone your fork of the repository to your local machine:

git clone https://github.com/your-username/BoomCam.git

Navigate to the project's directory:

Copy code
cd BoomCam

Install Dependencies

Install the project dependencies using Yarn:

Copy code
yarn install

Set Up the Development Environment

Run the development server:

Copy code
yarn dev

This will start the development server, and you can access BoomCam at http://localhost:3000.

Contributing Branching

Create a new branch for your contribution. The branch name should be descriptive of the feature or bug you are working on. For example:

Copy code
git checkout -b feature/new-feature

Code Style

Follow the existing code style and adhere to the linting rules. Make sure your code is well-formatted.

Commits

Please write clear and concise commit messages. Start the commit message with a verb in the present tense, e.g., "Add feature" or "Fix bug."

Pull Requests

When your contribution is ready, create a pull request from your branch to the main branch of the original repository. Include a detailed description of your changes and the problem it solves.

Code Reviews

All contributions will be reviewed by the maintainers before merging. Be open to feedback and be willing to make changes if necessary.

Reporting Issues If you find any bugs or have suggestions for improvement, please open an issue on the issue tracker.

Community and Communication Join our community on Discord to connect with other contributors and maintainers. Discuss ideas, ask questions, and collaborate.

Thank you for contributing to BoomCam! 🚀