Skip to content

Latest commit

 

History

History
128 lines (85 loc) · 4.74 KB

CONTRIBUTING.md

File metadata and controls

128 lines (85 loc) · 4.74 KB
Raw

👨‍💻 Prerequisite Skills to Contribute

Basics:

Built with:

💥 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 port-scanner 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>/port-scanner

3. Navigate to the newly created port-scanner project directory:

cd port-scanner

4. Set upstream command:

git remote add upstream https://github.com/thecyberworld/port-scanner.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 and commit:

⚠️ Make sure not to commit package.json or package-lock.json file, until and unless you have installed the new packages.

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

git add <changed-files>
git commit -m "<your_commit_message>"

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 port-scanner! 🙌🏼

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

Run project locally

Start the port-scanner application by typing this command:

npm run dev

Open the browser to visit the website at http://localhost:3000/port-scanner

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 fewer.
  • 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! 🥇

built with love