Skip to content

Latest commit

 

History

History
41 lines (31 loc) · 2.04 KB

CONTRIBUTING.md

File metadata and controls

41 lines (31 loc) · 2.04 KB

Contributors

This project is for Instagram users that need a simple bio link solution that want to make thier own rather than use a premade SaaS. In order to acomplish that goal we must be well documented and always make things easy for even non devs to understand.

New Contributor?

Weclcome friend! We would like to welcome anyone, no matter your skill level to contribute to this project. There are some very helpful resources online when it comes to learning how to code in a particular language.

Stack

In your learning efforts you should focus on these areas;

  • HTML
  • CSS
  • Javascript

How do I contribute?

  • Fork the repo using the fork button on the top right.
  • Once you have forked the repo, you are free to make changes in your fork as you wish.
  • Once you have made your changes - Open a PR to this repository (more on how to do that here) that targets the dev branch.
  • Your PR will then be code reviewed, to provide some positive feedback on how to improve or in areas that can be changed to avoid code errors.
  • Your PR may then be approved, and merged in.
  • Celebrate your hard work! 🎉

Test Your Changes

When making a pull request describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Testing should involve:

  • Page Speed Insights
  • Lighthouse Test
  • If template is dynamic test data

Do you have a demo hosted anywhere that can be visited?

Final Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added (or updated) documentation for users to use the template
  • I have made corresponding changes to the documentation (follow existing syntax)
  • My changes generate no warnings or errors

Thank you for considering to contribute to the QuickBioLinks!