Skip to content

Latest commit

 

History

History
65 lines (39 loc) · 2.26 KB

contributing.md

File metadata and controls

65 lines (39 loc) · 2.26 KB
Raw

Apertre'24 Contribution Guidelines

Welcome to Moment Gatherer!!
A flutter app where we can upload and store the images using the Firebase cloud storage bucket and providing it security by login with email and password.

Getting Started

Fork the Repository

To contribute, start by forking this repository. Click the "Fork" button at the top right corner of this page. This creates a copy of the repository in your GitHub account.

Clone the Repository

Clone your forked repository to your local machine. Replace <username> with your GitHub username.

git clone https://github.com/<username>/Moment-Gatherer.git

Now, you are ready to make your contributions.

Contribution Workflow

Branching

Create a new branch for your work. Choose a descriptive branch name related to the feature or fix you're working on.

git checkout -b feature/your-feature-name

Making Changes

Make your changes in the local repository. Ensure that your contributions align with the project's goals and guidelines.

Committing

Commit your changes with clear and concise commit messages. Reference any relevant issue numbers in your commits.

git add .
git commit -m "Your descriptive commit message closes #123"

Creating a Pull Request

Push your changes to your forked repository, and then create a pull request from there. Provide a clear title and description of your changes. Mention the related issue numbers in the pull request description.

We will review your contribution, provide feedback, and merge it if everything looks good.

Issues and Bugs

If you encounter any issues or bugs, please open an issue on the repository. Provide detailed information about the problem, steps to reproduce, and any relevant screenshots.

Community and Communication

Follow these points during your contribution. We appreciate open and respectful communication.

  • Always open an issue before contributing to the repository.
  • Get yourself assigned before starting to work on an issue. Check if someone is already assigned for it.
  • If there is inactivity from your side for quite some time, someone else will be given the chance.
  • Be respectful towards the community.
  • Mention the issue number on your PR.

Thank you for contributing to Apertre'24 ! ❤️