Skip to content

datalytika/calculateguru

Repository files navigation

🔥 Calculate Guru Collection

@datalytika/calculateguru
@Datalytika/calculateguru's issues @Datalytika/calculateguru's pull requests


🤔 What is this repo all about?

  • This repo is a collection of, summarily, calculators. The solutions here can be used in web apps to facilitate back-end calculations eg; mortgage interest calculators for lenders websites.
  • We plan to make this repo easy to maintain and navigate by documenting all builds here in this README.md section.
  • For example; the table of contents below will have a link to the specific folder and a description of what the file is all about.
  • All the markdown follows "MarkdownLint" rules!
  • Make the community healthier with all the guides like code of conduct, contributing, support, security... I'll assume we have a basic idea of how to use git. Well, I'll share some steps below.

Contributing

If you want to contribute to this project and make it better, your help is very welcome. There are no special instructions on how to contribute to this project, but I'll note down steps if you're new to git.

How to make a clean pull request

  • Create a personal fork of this project on Github. Click me to fork this project now.
  • Clone the fork on your local machine. Your remote repo on Github is called origin.
  • Add the original repository as a remote called upstream.
  • If you created your fork a while ago be sure to pull upstream changes into your local repository.
  • Create a new branch to work on! Branch from develop if it exists as you read this, but I don't think we'll apply that here so just branch from master.
  • Implement/fix your feature, comment your code.
  • You'll have to add or change the documentation as needed after you contribute. The documentation is not so special for this project - there's a 'table of contents' at the bottom of this README.md. Follow the script as earlier contributions have done. Just link to the folder and a description of what your build does. We'll do this in alphabetical order.
  • At times you have many commits. Squash them into one commit with git's interactive rebase. Create a new branch if necessary.
  • Push your branch to your fork on Github, the remote origin.
  • From your fork open a pull request in the correct branch. Target this project's develop branch if it exists as you read this. If not, go formaster!
  • If the project's patron ;), currently Lweya Joe, requests further changes, just push them to your branch.
  • Once the pull request is approved and merged you can pull the changes from upstream to your local repo and delete your extra branch(es).

⚠️ Please, let's ensure our commit messages are in present tense. A commit message should describe what the commit, when applied, does to the code – not what you did to the code. ⚠️

⚠️ Please, note that your sub-project can have its own README.md and documentation. It's good practice. Your README.md would obviously be inside your project's folder. ⚠️

⚠️ Some contributors would like to share screenshots of tests on their build. Please do not upload image files to the repo. We recommend all images to be shared as links to imgur ⚠️


📚 Table of Contents

  1. Property Value Calculator
    1. Initial contributor: Joseph Lweya
    2. Additional contributors: ... ... .
    3. Project files: Link
    4. Project description: This calculator estimates the value of your property based on inputs from historical data.

🔖 Using .github/settings.yml

The bot probot-settings is installed for this repo. Don't worry if you are not familiar with it. Hint: It allows a contributor to change the settings of this repo. ie; You can now create and push changes to the repo's settings. That means a repo-name-change request can be pushed by you, pulled and then approved and merged by the maintainer of this project.


🛡️ Security policy

Security issue.


🕵️ Extra recommendations

If you want to improve the development of this project, you must, after changing or improving whatever, run the project's tests to prove that they are working.

To do so: Use compiler at Techie's Site


🍰 Supporters

@Datalytika/calculateguru's brand logo without text

We are not currently looking for donators. Just support. You can support by mentioning this project in blogs, news articles etc. Help maintain this project by recruiting contributors! ❤️

By supporting, you will help the development of this project, and you will be featured in this project's README.md on the supporters section, so everyone can see your kindness and visit your content ⭐.

🍰 List of Supporters


🎉 Is the project useful? Help us raise these numbers up

GitHub's followers GitHub stars GitHub watchers GitHub forks

Enjoy! 😃

Made with a lot of ❤️❤️ by @Datalytika

About

No description, website, or topics provided.

Resources

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published