Skip to content

Latest commit

 

History

History
74 lines (49 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

74 lines (49 loc) · 2.56 KB

Contributing 👥

Tech stack ⚛️

This desktop application is built with Electron.
Bootstrap is used for styling on both the download website and the application itself.

Project structure 📂

src/

The UI and brains of the application are containd in this directory.

The application UI is defined within src/public.
The memory downloading logic is in src/memoryDownloader.js, which utilizes several services found in src/services.

src/public/

Files in this directory are served as the static frontend of the electron application.

src/services/

Many of the helpful services (i.e., download services) are contained in this directory.

docs/

Contents in this directory are served via the download website, downloadmysnapchatmemories.com.

Requirements ✅

When contributing, ensure you are working to close an issue on the repository. You can choose a pre-existing issue that is not being apparently worked on by anyone else. You may also create and request to be assigned to a new issue.

Version bumping

In order for contributions to be approved, they must include a version bump. This includes contributions that only make changes to the docs.

To bump the app version, run the npm version command with the appropriate version increase.

npm version <major|minor|patch>

Follow basic semantic versioning guidelines when incrementing the application version.

Create a Contributor entry 🧑‍💻

Contributor entries are JSON objects stored in array in docs/contributors.json. They must follow the pattern below.

{
  "name": "John Smith",
  "role": "Collaborator",
  "links": {
    "GitHub": "https://github.com/jsmith",
    "Youtube": "https://www.youtube.com/channel/johnsmith",
    "Website": "https://www.johnsmith.io"
  }
}

Contributor entries without a linked GitHub profile will not be accepted.
Youtube and Website links are optional.