Skip to content

Latest commit

 

History

History
130 lines (93 loc) · 6.82 KB

CONTRIBUTING.md

File metadata and controls

130 lines (93 loc) · 6.82 KB
Raw

Contributing to Golang Tutorial

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new concept
  • Becoming a maintainer

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

We Use Github Flow, So All Code Changes Happen Through Pull Requests

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

This is an example of a bug report, and I think it's not a bad model. Here's another example from Craig Hockenberry, an app developer whom I greatly respect.

People love thorough bug reports. I'm not even kidding.

Checkout the following steps to make your hands dirty💪🏻

1. Fork the repo and create your branch from main.

  • click this fork icon to fork(download a copy) this repo to your account image

  • After clicking this fork icon, you will be redirected to this following page

  • click the green button Create fork image

2. Write bug reports with detail, background, and sample code

Case 1: You want to create a new issue🪲

  • If you've got any bug/typo-mistakes/suggestions go ahead a click on this Issues icon image

  • Click on New Issue icon

  • You will be redirected to the following page👇🏻 image

  • If you want to fix problems among Bug, Documentation and Features , proceed forward

  • Otherwise click on the Open a blank issue image

  • Give proper "Title" and "Description" to your issue and click Submit new issue

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

image

Case 2: Working on existing issue(s)🐛

  • Take a look on the existing issue section. If you can one/more, proceed forward and ask project admin to assign yourself image 💡Tip : Click on the label button to see the categories of issues image
  • Depending upon your expertise/interest click any of them and find issue to solve
  • If anyone already assigned already, ask maintainer to assign yourself(if and only if the existing assigned contributor fails to solve the issue)
  • After getting assigned yourself, it's your job to showcase your skills to community by contributions🤹🏻‍♂️

3. Contribution

Step 1: Setup the project in your local machine

  • After forking the repo, you will get a link on clicking the Code button image

  • Copy that LINK

  • Go to your favourite location in your device and open your terminal

  • Type git clone <LINK> to download project in your local system

  • Type cd <Project_Folder>

  • Type code . to open it in your code edtor

Step 2: Put your work on it

  • Do whatever you want to change in the project, It totally depends on your skill ** Points keep in mind while contribute**
  • [1] Make sure your code is clean.
  • [2] Maintain the coding pattern in existing codebase.
  • [3] Ask help in public(In comment section of issue) if needed.
  • [4] Add meaningful comments to make your code readable by others.
  • [5] Maintain the existing markdown format for non-code contribution, check this to get more info

4. Pull Request

After doing changes do the followings

  • Open terminal for project directory in code-editor
  • Create a new branch by typing git checkout -b <NEW_BRANCH_NAME>
  • Type git status to check the non stagged file
  • Type git add <file_name> to stage the files
  • Type git commit -m "<COMMIT_MSG>" [ COMMIT_MSG ] should contain the meaningful text about file changes
  • Type git push origin <NEW_BRANCH_NAME>

After pushing changes to your local repo do the followings

You will see the followings, click the Compare & Pull Request image

  • Give your PR a proper context
  • Add Screenshot, Texts, More info to be verified your work by maintainers Click on the Pull request button image

-Maintainers will review your changes and give you suggestions regarding that -If they tell you to do some more changes, follow them and ask for help if needed -Otherwise they will accept your changes and will MERGE your Pull Request!!

Give a shoutout to yourself 🎉

  • You have successfully made a PR that has been merged✅

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

License

By contributing, you agree that your contributions will be licensed under its MIT License.