Skip to content

Latest commit

 

History

History
150 lines (96 loc) · 5.28 KB

CONTRIBUTING.md

File metadata and controls

150 lines (96 loc) · 5.28 KB
Raw

Contributing Guidelines for Freefolio App 👨‍💻

👨‍💻 Prerequisite Skills to Contribute

Contribute in Documents

💥 How to Contribute

PRs Welcome Open Source Love

  • Take a look at the existing Issues or create a new issue!
  • Fork the Repo. Then, create a branch for any issue that you are working on. Finally, commit your work.
  • Create a Pull Request (PR), which will be promptly reviewed and given suggestions for improvements by the community.
  • Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes proposed in your PR.

⭐ HOW TO MAKE A PULL REQUEST:

1. Start by making a Fork of the Freefolio repository. Click on the Fork symbol at the top right corner.

2. Clone your new fork of the repository in the terminal/CLI on your computer with the following command:

git clone https://github.com/<your-github-username>/freefolio

3. Navigate to the newly created LinkFree project directory:

cd freefolio

4. Install dependencies:

npm install

5. Create a new branch:

git checkout -b YourBranchName

⚠️ Make sure not to commit package.json or package-lock.json file

⚠️ Make sure not to run the commands git add . or git add *. Instead, stage your changes for each file/folder

6. Start developement:

All template must conform to the following criteria:

  • The template is not a direct copy of an existing template, be creative create your own design ;)
  • The template must not contain vulgar words, images, or any other similar content
  • The template must not promote people, government, political parties, or any other organization

Technical criteria:

  • The index.html must have a title and meta description tag
  • The title tag should be <name of template> a Freefolio template by OSSPH
  • You can use any CSS framework like bootstrap, tailwind, etc. As long as they are imported via CDN
  • Your template must be static, meaning no dynamic data from outside the code is required for it to work
  • Do not use excessively large images, you can compress your assets using https://tinypng.com/

And most importantly:

  • Have fun! <3

7. Add those changes to the branch you just created using the git add command. To let Git track files for a commit, we need to run the following in the terminal:

git add my_new_file

And for adding several files to the staging area in one go. Do this instead, it is more convenient.

git add .
  • After git add command see status with git status command:
git status

8. Now commit those changes using the commitizen command:

npx cz

9. Push your local commits to the remote repository:

git push origin YourBranchName

10. Create a Pull Request!

11. Congratulations! You've made your first contribution to Freefolio! 🙌🏼

🏆 After this, the maintainers will review the PR and will merge it if it helps move the freefolio project forward. Otherwise, it will be given constructive feedback and suggestions for the changes needed to add the PR to the codebase.

🍃 Running tailwindcss in environment watch mode

Enter the following command in your terminal:

yarn dlx tailwindcss -i global.css -o index.css --watch

add the following line to your index.html file:

<link rel="stylesheet" href="index.css" />

Style Guide for Git Commit Messages 📝

How you can add more value to your contribution logs:

  • Use the present tense. (Example: "Add feature" instead of "Added feature")
  • Use the imperative mood. (Example: "Move item to...", instead of "Moves item to...")
  • Limit the first line (also called the Subject Line) to 50 characters or less.
  • Capitalize the Subject Line.
  • Separate subject from body with a blank line.
  • Do not end the subject line with a period.
  • Wrap the body at 72 characters.
  • Use the body to explain the what, why, vs, and how.
  • Reference Issues and Pull Requests liberally after the first line.

💥 Issues

In order to discuss changes, you are welcome to open an issue about what you would like to contribute. Enhancements are always encouraged and appreciated.

All the best! 🥇