Skip to content

Latest commit

 

History

History
60 lines (36 loc) · 2.84 KB

README.md

File metadata and controls

60 lines (36 loc) · 2.84 KB

Goal & Habit Tracker | Hacktoberfest SwiftUI 🚀

platform GitHub license

The aim of this app is so that users can track their habits and goals. This project is open source and allows all skill levels to contribute to Hacktoberfest - it also means you can earn some Swag (from stickers to t-shirts). The project is built using Swift and uses SwiftUI.

Consider leaving a ⭐ if you like the repository.

Who Can Contribute? 👩🏽‍💻

  • Anyone of all skill levels can contribute to this repo
  • Please ensure that you have signed up at Hacktoberfest
  • Please check all issues that are labelled as Hacktoberfest
  • Some issues are labeled as good-first-issue these are great for beginners to get involved

Before working on an issue please leave a comment and you will be assigned

Getting Started 🙌

  • Fork the project

  • Open your forked project in GitHub and click on the green <>Code button.

  • Copy the HTTPS or SSH link and open your Terminal / Git Bash.

    git clone <the link>
    
  • Run project (to ensure everything works)

  • Checkout a new branch to work on an issue:

    git checkout -b name-of-issue-ticketNumber
    
  • Once you've finished coding / working on an Issue, you can open a new PR

    git add . 
    git commit -m “Description of what was sorted”
    git push origin name-of-issue-ticketNumber
    
  • Open the project on GitHub and raise to master branch on the repo

Supporting Files

Contributing 🤖

To start contributing, check out contributing.md. Everyone is welcome to contribute to this project, if you’re new to programming you might want to check out issues labeled as UI-Improvements and good-first-issue. Before you assist with the development, please set up the project on your local machine, run it, and go through the application.

Please read the Architecture.md to understand the flow and the structuring of the app.

Project Maintainers 😎

✨ A special thanks to all contributors.

License

This project is licensed under Apache License 2.0.