DEV Community: Japneet Singh

RELEASE 0.4 - Week 3 collaborating on open source projects - Final

Japneet Singh — Sat, 11 Dec 2021 04:35:22 +0000

Words on taking OSD 600

Hello Everyone, I took this course to learn about open source development but I can say I learned much more from it. Each week, we worked on learning something new and then contributing to each other's code. Also, having great feelings about resolving small bugs and dealing with major issues. To sum up, It all went really well and had a great learning experience.

Working with other developers

I personally believe the atmosphere around open-source development is important. This was greatly completed in this course due to two applications 1. Slack and 2. Telescope. Reading out each other posts and helping out was something missing during my early education. Pointing out small errors and making all of us realize our mistakes was very important.

Advise new developers

I would recommend this course to all who want to get a feel on how you contribute to an open-source project. It also teaches you how to interact and help each other out to do better in terms of learning a new language or fixing a bug.

Final Good-Bye

Thank you each and every one! Have a wonderful holiday! See you all soon.

RELEASE 0.4 - Week 2 collaborating on open source projects - progress

Japneet Singh — Fri, 10 Dec 2021 04:46:31 +0000

Introduction

Hello, Welcome to week#2 on open-source code development. I did a lot of looking at different codes with different languages. This blog includes all successful and unsuccessful attempts at contributing projects.

First Project - Free-Programming-Books

This project includes a list of Free Learning Resources in many languages. I liked the idea of having so many books for free for all developers.

Issue #1
I enjoyed contributing to this project and have divided sections for different programming books.
PR #1

Second Project - Developer-mozilla

MDN Web Docs (previously known as MDN — the Mozilla Developer Network) is an evolving learning platform for Web technologies and the software that powers the Web, including CSS, HTML, and JavaScript. We also have a detailed set of beginner's learning material — see Learn Web development.

Issue #2
I enjoyed contributing to this project and changed the link to support the needs.
PR #2

Third Project - open-props

CSS custom properties to help accelerate adaptive and consistent design.

[Issue #3(https://github.com/argyleink/open-props/issues/111)]
I am still working on this project and will add more design tokens to the application. Please find the link to contribute to this open-source project.
PR #3

Unsuccessful Attempts on other projects

Not everything go as planned, I wasn't able to do some developments to these issues. So, maybe anyone interested can take a look at resolving these.

Issue #1
Issue #2
Issue #3
Issue #4

Conclusion

All in all, it was a great experience to work with such project developers this week. Also, I will be contributing to learning from an open source more and more in future. Please do like & comment.
Thank you!

RELEASE 0.4 - Week 1 collaborating on open source projects - beginners

Japneet Singh — Tue, 07 Dec 2021 10:43:59 +0000

Introduction

Hello, Welcome to my blog to find the process of collaborating on open source projects. I am considering you all know where you can contribute.
To look for trending open source projects: Github

Contribution stages

Stage 1:

To begin with, we need to find the project to commence with development. This initiative can be cumbersome for new developers. So, to make this simple try narrowing down choices such as using tags, language, open issues etc. It will help you find the project that best suits your knowledge and do it within the desired timeframe.

Stage 2:

The next task, start building and testing the application/source co on your device. It will tell you to confirm all operations works accurately. Now, the main component is to ask the developers of the project. If they need help in the project. This way, it will be confirmed the project you are going to work is active.

Stage 3:

Lastly, choose the projects you think will make your knowledge broader.

Release 0.4 projects

I have chosen these projects because I believe I can finish these tasks. I would contribute towards EbookFoundation, tldraw & mdn documentation resolving bugs & adding features.

List of issues:

Issue #1
Issue #2
Issue #3
Issue #4
Issue #5

Overview

If you had like to avoid confusion during the selection of a project keep one thing in mind: A developer doesn't need to know all the languages, only needs to master one.

Creating Command Line Tool using swift package manager

Japneet Singh — Sat, 27 Nov 2021 03:32:29 +0000

Introduction to SPM

The release tool used in swift programming is a swift package manager Package Manager
The Swift Package Manager is a tool for controlling Swift code distribution. It works with the Swift build system to automate the download, compilation, and linking of dependencies.
-The Package Manager is included in Swift 3.0 and above.-

$ swift package init --type executable

Release version to command-line-Tool

You'll want to install your command-line utility after you've finished developing it. This can be accomplished by using the release configuration while building. Within the.build/release folder, an executable will be created. We need to copy it into the /usr/local/bin folder before we can utilise it.

$ swift build --configuration release
$ cp -f .build/release/banner /usr/local/bin/banner

Using Git Tags

git tag  -a v1.1 -m "ModernSSG version"

User Testing

Well, I partenered with ritik bheda, he made his project in node.js. Testing with node.js is simpler and easier task. I tested the project and we didn't run into any error. It was very well communicated with other members to test project build in their language.

How to use and run my swift project

$ swift build
$ swift run

or
Double click the ModernSSG executable file to run the project.

Internal Project Contribution - Release 0.3

Japneet Singh — Sat, 20 Nov 2021 03:48:59 +0000

Introduction

Open source refers to source code that is made available to the public to view, use, modify, and distribute under a license. Although the main point of open source projects is to create valuable and accessible open source software, individual contributors can get plenty of personal benefit from contributing to them Projects: IPC144&telescope

First Issue :

Audit and fix library-functions.md Issue #1

Checklist

Found multiple typos and fixed them.
Fixed uppercase letter to suit all other heading letters.
Multiple warnings running lighthouse
Multiple warnings running Web Hint
correct use of bacticks
correct use of syntax highlighting, not for outputs to make it look different.
Accessibility tested!
fixed heading errors
Improve readability of code comments
Fixed Frontmatter for the page to include proper id, title, slug, etc.

Conclusion

Auditing and fixing .md file made me use different
developers.google.com/web/tools/lighthouse
Web Hint: webhint.io.

Second Issue :

Improve dark mode code colours Issue #2
This issue was about enabling dark mode colour for syntax highlighting according the toggle click and the issue was not resolved due to wrong implementation. However, it is important to learn the importance of open source development. I made a draft pull request for other to review and help me find the right solution. I will keep working on it until the real solution is found.

Conclusion

Contributing towards open source projects helps the community and your peers get to know you. This recognition can bring you a lot of opportunities in your career. It helps you learn more about a project. It improves your coding skills.

Pull requests

PR #1
PR #2

Author

[@japneetsingh035

External Project Contribution - Release 0.3

Japneet Singh — Sat, 20 Nov 2021 03:48:21 +0000

PROJECT CONTRIBUTION REPO

Description

Countdown timer made using the Python time module and is a terminal game to countdown the time.
https://github.com/Python-World/python-mini-projects/pull/538

Development

Please have python3 installed to run this project on terminal:
Python3 Installation

import time

def countdown(t):
    while t:
        mins, secs = divmod(t, 60)
        timer = '{:02d}:{:02d}'.format(mins,secs)
        print(timer, end="\r")
        time.sleep(1)
        t -= 1

    print('Timer completed!')

t = input('Enter the time in seconds: ')

countdown(int(t))

Prerequisites

Modules required to be able to use the script successfully
and how to install them. Please have python3 installed to run this project on terminal:

How to run the script

python3 main.py

Example

Enter the time in seconds: 20
00:20
Timer completed!

Screenshot/GIF showing the sample use of the script

Pull Request

Author Name

JapneetSingh

Code Reviews - Release 0.3

Japneet Singh — Sat, 20 Nov 2021 03:46:31 +0000

Introduction

Code review is when you go through your code and make sure everything works. The most popular approach for assessing feature design and implementation is code review.

Your team can devise review procedures that will increase the quality of your code while also fitting into your workflow.

Code Review Checklist

A code review checklist is a set of rules or questions that you and your team will use during the code review process. Many teams, whether they realise it or not, are already performing code reviews.

What to Look for When Conducting a Code Review
Before reviewing, build and test.
Do not spend more than 60 minutes reviewing the code.
At any given time, no more than 400 lines should be checked.
Communicate Goals and Expectations with Feedback.
Participate in the Code Review Process with Everyone.

My First review code

Audited and fixed functions-arrays-and-structs.md #96

I found this colSpan needs to be replaced with colspan. Line 838: colspan
Also, Maybe removing the ... and adding it to end. Line 32: type identifier(type [parameter], ...);

Code-Review #1

My Second review code

Reviewed: Tutorial for Converting Table-like Diagrams into Images
Code-Review #2

Conclusion

Code review is a software quality assurance process in which the source code of software is manually reviewed by a team or using an automated code review tool. The goal is to find bugs, fix errors, and, in most cases, improve code quality.

Working with Github Actions CI Workflow - Swift Programming

Japneet Singh — Fri, 19 Nov 2021 09:27:33 +0000

Introduction

To set up Github Actions CI Workflow for swift. You will be required to visit your repository on GitHub.

On GitHub.com, navigate to the main page of the repository.
Under your repository name, click Actions.
If you already have a workflow in your repository, click New workflow.
Find the template that you want to use, then click Set up this workflow.

name: Swift

    on:
     push:
     branches: [ main ]
     pull_request:
     branches: [ main ]

    jobs:
     build:

     runs-on: macos-latest

     steps:
     - uses: actions/checkout@v2
     - name: Build
     run: swift build -v
     - name: Run tests
     run: swift test -v

Working on other repo

Successful GitHub action workflow on pull request.
Workflow #

I worked on CI for testing on javascript using jest. This testing function would allow to check if css stylesheet is passed.

test("should be able to pass specified style", () => {
        expect(
            checkGenPageArgsWithCSS(
                data,
                data.texts,
                data.title,
                data.stylesheet,
            ),
        ).argv_s = `<link rel="stylesheet" type="text/css" href="please_add_your_css_path" />`;
    });

GITHUB PR

Conclusion

All in all, CI enables Organizations to scale their engineering teams, codebases, and infrastructure. It enables each team member to take ownership of a new code change from conception to completion. This will help you to be the rightful owner for the code to be tested before release.

Adding Testing integration in swift using xctest

Japneet Singh — Fri, 12 Nov 2021 23:03:25 +0000

Introduction

Welcome to an introduction to how to integrate testing in ios projects. The framework I chose for my project is XCtest which is an automation tool provided by Apple. Use the XCTest framework to write unit tests for your Xcode projects that integrate seamlessly with Xcode's testing. documentation

Setup

Please follow the instruction to set up the XCTest for your Xcode project.

To run the tests in swift

$ swift test

Shortcuts

These shortcuts are essential when writing unit tests in Xcode.

Command + U to run all tests.
Command + Option + Control + G to run latest test.

Errors encountered

Fixed errors

    if(input.isEmpty){
        print("Error. Please enter input folder or add suffix to file name")
        return
      }

Outcome

Learning from testing is to cover all arguments or other ways possibilities of having errors. While testing helps to come up with all scenarios that can cover all errors. Commits: commits

How to improve swift code using SwiftLint & Swiftformat

Japneet Singh — Sat, 06 Nov 2021 04:00:52 +0000

Hello Everyone, Welcome to my blog on how to format swift code using swiftformat & swiftlint.

TOOLS USAGE

$ brew install swiftformat
$ swiftformat [fileName]

$ brew install swiftlint
$ swiftLint [fileName]

INTEGRATE XCODE

Integrate SwiftLint into your Xcode project to get warnings and errors displayed in the issue navigator.
To do this click the Project in the file navigator, then click the primary app target, and go to Build Phases. Click the + and select "New Run Script Phase". Insert the following as the script:

Similarly, create the build phase with Swiftformat.

ISSUES RELATED TO SOURCE CODE

Issues found during the lint format:

Tool to run from command line

$ swift run ModernSSG | swiftformat .

Other IDE Integrations

AppCode

To integrate SwiftLint with AppCode, install
this plugin and configure
SwiftLint's installed path in the plugin's preferences.
The autocorrect action is available via ⌥⏎.

2.Atom

To integrate SwiftLint with Atom, install the
linter-swiftlint package from
APM.

Visual Studio Code

To integrate SwiftLint with vscode, install the
vscode-swiftlint extension from the marketplace.

Conclusion

This source code format in swift is easy and prominent for the development process and makes code less prone to small errors. This development will surely reduce the issues and make a constant format for new projects.

Commits

merged_commit

Hacktoberfest Final Week

Japneet Singh — Sun, 31 Oct 2021 09:02:37 +0000

Introduction

Hello, I hope you all had a crazy Hacktober fest this month. A lot of coding and working day-night. For me, it has been a great experience. I met a lot of good developers and issues to get started. I don't know if I did everything the right way or not. However, I had a lot of fun learning experiences.

Finding Projects

It is not easy to find the right project to start. It took hours to look for one project where a contribution is possible. I used bookmarks to hold on to issues. This week I got stuck with two issues one being major and one being shorter.

Issues

Issue#49
This issue is related to adding the feature to the live website. It is a weather website that has a background simulation of different weather types. It already has sun & rainy weather. I searched about the article if I will be able to do it, then asked the developer to let me work on this. Instantly, I was assigned the task with another assignee. I wanted to make snow season stimulation. Do check out the git link to contribute to this Weather Venure
Issue#2377
The second issue, I wanted to start with Seneca's open-source involvement. So, here I started with a small issue to our blog collection application Telescope.

Preparation

I believe pre-requisites are very helpful to set up environments but, I don't know how still get some silly errors all the time. So, the best way to solve this situation is to ask the developer for help. It solves my error always and hope it does the same for you too.

Learning Experience

This work on i worked on node.js project which was more of involved with css and little bit of javascript. However, It was great initiative to work on different projects this hactoberfest. My next project is telescope to setup and be ready to contribute to our application.

After:

Interactions:

I have great conversations with my co-developers. They are very helpful and it builds great environment to work on. The appreciation boots your energy to do more work. My pull request was not submitted due to my wrongful attempt to issue, but the way it was handled was well.

Link to Pull Requests:

PR#66

Adding more features to SSG similar to docusaurus

Japneet Singh — Fri, 29 Oct 2021 08:30:25 +0000

Introduction to Docusaurus

Docusaurus is a tool designed to make it easy for teams to publish documentation websites without having to worry about the infrastructure and design details. Docusaurus also provides core website and documentation features out-of-the-box including blog support, internationalization, search, and versioning. For more info.
To anyone who wants to design a webpage without coding knowledge can use this open-source project.
Easy to deploy and easy-to-use pre-design webpages for your website.
Intro to docusaurus

Features copied from Docusaurus

Well, I was impressed looking at docusaurus implementing so many features to their website. I wanted to work on Theme and Search Engine Optimization that required a lot of effort and knowledge. So, I started with some basic features that support my ModernSSG.

Approach

I wanted to make my Html page more supportive with Markdown. I did it by adding more supports to tags.

Improved Accessibility of generated HTML
Full Markdown support
Syntax Highlighting for code blocks

Future Features

Well, I would love to work on Issues. If anyone is interested to practice with this static site generator feel free to reach out.

Example of feature

//Improved Accessibility of generated HTML
 data = data.replacingOccurrences(of: "```

bash", with: "<pre><code>", options: .regularExpression)
                    data = data.replacingOccurrences(of: "

```", with: "</code></pre>", options: .regularExpression)

More issues

Pull requests are welcome. For changes, please open an issue first to discuss what you would like to change.

Static Assets for images, stylesheets, etc.
Themes
Configurable Sidebar (i.e., table of contents)
Blog posts in addition to Pages
Search Engine Optimization (SEO)