Skip to content

Latest commit

 

History

History
93 lines (59 loc) · 3.12 KB

CONTRIBUTING.md

File metadata and controls

93 lines (59 loc) · 3.12 KB

Contributing to the Photo Album Showcase Application

Welcome to the Photo Album Showcase Application project! We're excited that you're interested in contributing to our open-source project. By participating in this project, you can help make it even better.

Before you start contributing, please take a moment to read through this guide to understand our contribution process.

Table of Contents

How Can You Contribute?

You can contribute to this project in several ways, including but not limited to:

  • Fixing bugs and issues
  • Implementing new features or enhancements
  • Improving documentation
  • Writing tests
  • Providing feedback and suggestions

Every contribution, no matter how small, is valuable and appreciated!

Getting Started

Fork the Repository

First, fork this repository to your own GitHub account by clicking the "Fork" button at the top right corner of this page.

Clone Your Fork

After forking, clone your forked repository to your local machine. Replace damc-dev with your GitHub username.

git clone https://github.com/damc-dev/photo-album-showcase.git

Install Dependencies

Navigate to the project directory and install the required dependencies:

cd photo-album-showcase
npm install

Making Changes

Create a Branch

Before you start making changes, create a new branch for your work. Give your branch a descriptive name related to the issue or feature you're working on.

git checkout -b your-branch-name

Code Guidelines

Please follow our coding guidelines when making changes to the codebase. Consistent code style makes it easier for us to review and merge your contributions.

Testing

Ensure that your changes are well-tested. If you're fixing a bug, add a test case that reproduces the issue and ensure that it passes after your fix. If you're adding a new feature, write tests to cover it.

To run tests, you can use the following command:

npm test

Submit a Pull Request

Once you're satisfied with your changes, submit a pull request (PR) to the main branch of this repository. Provide a clear and concise description of your changes in the PR description. Be sure to reference any related issues.

We will review your PR as soon as possible and provide feedback if needed. Thank you for contributing!

Code of Conduct

Please note that this project follows a Code of Conduct. By participating, you are expected to uphold this code. Please report any unacceptable behavior to damc.dev@gmail.com.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.