Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Populate index.md #53

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Populate index.md #53

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions docs/development/contribution/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,53 @@
title: "Contribution"
sidebar_position: 1
---

# Contributing to LibrePhotos

Thank you for considering contributing to LibrePhotos! We welcome contributions from everyone. Here are some guidelines to help you get started.

## How to Contribute

1. **Fork the Repository**: Start by forking the relevant LibrePhotos repository to your GitHub account; please also reference their pages. There are the [Frontend](https://docs.librephotos.com/docs/development/contribution/frontend/), [Backend](https://docs.librephotos.com/docs/development/contribution/backend/), [Docker](https://docs.librephotos.com/docs/development/contribution/docker), and [Mobile](https://docs.librephotos.com/docs/development/contribution/mobile/) guides.

2. **Clone the Repository**: Clone your forked repository to your local machine.
```sh
git clone https://github.com/your-username/repository-name.git
```

3. **Create a Branch**: Create a new branch for your feature or bug fix.
```sh
git checkout -b my-feature-branch
```

4. **Make Changes**: Make your changes to the codebase. Ensure your code follows the project's coding standards.

5. **Commit Changes**: Commit your changes with a descriptive commit message.
```sh
git commit -m "Description of my changes"
```

6. **Push Changes**: Push your changes to your forked repository.
```sh
git push origin my-feature-branch
```

7. **Create a Pull Request**: Open a pull request to the main repository. Provide a clear description of your changes and why they are necessary.

<!-- ## Code of Conduct

Please note that this project is released with a [Contributor Code of Conduct](https://github.com/LibrePhotos/librephotos/blob/main/CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms. -->

## Reporting Issues

If you find a bug or have a feature request, please create an issue on the relevant issue tracker, such the [backend issue tracker](https://github.com/LibrePhotos/librephotos/issues).

## Getting Help

If you need help, feel free to ask questions on our [Discord server](https://discord.com/invite/xwRvtSDGWb). You can also watch watch development videos on [Niaz Faridani-Rad's channel](https://www.youtube.com/channel/UCZJ2pk2BPKxwbuCV9LWDR0w).

## Documentation

Please refer to the [documentation](https://docs.librephotos.com) for more information on how to use and contribute to LibrePhotos.

We appreciate your contributions and look forward to working with you!