Skip to content

Latest commit

 

History

History
90 lines (59 loc) · 5.73 KB

CONTRIBUTING.md

File metadata and controls

90 lines (59 loc) · 5.73 KB
Raw

👋 Welcome to the Safe contributing guide

Thank so much for investing your time in contributing to Safe!

Read our Code of Conduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Getting started

Commit Convention

One of the most important aspects of versioning is the commits that define changes. However, commits are useless if they don't denote what changes or additions they are making. Given this reason, we use performant commits; a commit message convention that consists of three main components:

  • Prefix (this defines what type of change was made)
  • PWD (this is where the bulk of the change was made)
  • Change (this is the actual change that was made)

Example

ft[screens/location] ⇒ 📍 Add Google Maps integration to LocationScreen widget

  1. The ft denotes that this is a feature change.
  2. The [screens/location] denotes that the change is in the screens folder and in the location file.
  3. Anything after the ⇒ is the actual commit message describing the change.

Issues

Create a new issue

If you find an issue with the repository or have a feature request with Safe, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See Labels for more information. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

Make changes locally

This project uses Flutter. Ensure you have them installed before continuing. Here are the following installation links of Flutter:

Note: Safe is being developed primarily on iPhone emulators. Therefore, there might be critical issues when trying to run the app on Android. If you'd like to develop on android, reach out to [email protected]

  • $ git clone https://github.com/safedotme/safe
  • $ cd safe
  • For Linux or MacOS users run: flutter pub get
    • This will install all of the required dependencies for Safe to build.
  • $ flutter pub run build_runner build --delete-conflicting-outputs - Runs all necessary codegen & builds required dependencies.

To quickly run only the iOS app after prep you can use:

  • $ open -a Simulator.app
  • $ flutter run

If you are having issues ensure you are using the following versions of Flutter, Dart, and iOS:

  • iOS version: 16
  • Dart version: 2.17.5
  • Flutter version: 3.0.3

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a team member will review your proposal. We may ask questions or request for additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🎉🎉 The Safe team thanks you ✨.

Once your PR is merged, your contributions will be included in the next release of the application.

Credits

This CONTRIBUTING.md file was modelled after the github/docs CONTRIBUTING.md file, and we thank the original author.