Skip to content

Latest commit

 

History

History
141 lines (90 loc) · 4.74 KB

CONTRIBUTING.md

File metadata and controls

141 lines (90 loc) · 4.74 KB
Raw

Contributing

The following is a set of guidelines for contributing to Facts-Website, which is hosted on Github. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How Can I Contribute?

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.

⭐ HOW TO MAKE A PULL REQUEST:

1. Start by making a Fork of the Facts-Website 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>/Facts-Website

3. Navigate to the newly created Facts-Website project directory:

cd Facts-Website

4. Set upstream command:

git remote add upstream https://minhaj-313.github.io/Facts-Website.git

5. Create a new branch:

git checkout -b YourBranchName

6. Sync your fork or your local repository with the origin repository:

  • In your forked repository, click on "Fetch upstream"
  • Click "Fetch and merge"

Alternatively, Git CLI way to Sync forked repository with origin repository:

git fetch upstream
git merge upstream/main

Github Docs for Syncing

7. Make your changes to the source code.

8. Stage your changes:

⚠️ 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

By using public path it means it will add all files and folders under that folder, it is better to be specific

git add public

or

git add "<files_you_have_changed>"

9. Commit your changes:

git commit -m "<your_commit_message>"

10. Push your local commits to the remote repository:

git push origin YourBranchName

11. Create a Pull Request!

12. Congratulations! You've made your first contribution to Facts-Website! 🙌🏼

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

Contributing Guidelines

ℹ️ Please follow the code of conduct in all the interactions with Searchor and your fork repository. This repository welcomes all contributions and corrections. Before contributing, please make sure you have read the guidelines below.
If you're new to git and/or GitHub, we suggest you go through the GitHub Guides.

  1. Fork this repository

  2. (Optional) Clone the fork via git

    • Using SSH

      git clone --filter=tree:0 git@github.com:devict/ictgamejam.git

    • Using HTTPS

      git clone https://minhaj-313.github.io/Facts-Website.git

    • Using GitHub CLI

      gh repo clone https://minhaj-313.github.io/Facts-Website.git

  3. Create a new branch

  4. Start hacking on the new branch

  5. Commit and push to the new branch

  6. Make a pull request towards the original repository (minhaj-313)

Pull Request Guidelines

Please ensure your pull request adheres to the following guidelines:

  • Make sure someone else has not already pulled the request for the changes you wish to do.
  • The code should be without any warnings and errors.
  • Any changes or suggestions to the existing content or repository are welcomed.

You don't need to worry as admins will request the changes needed in the pull request before merging.

Feedback:

If you have any feedback or suggestions please create an issue where you can mention some new features or extensions that will enhance this project✨.