Skip to content

Latest commit

 

History

History
70 lines (52 loc) · 2.95 KB

CONTRIBUTING.md

File metadata and controls

70 lines (52 loc) · 2.95 KB
Raw

Contributing

This project needs you! If you found an issue, or you want to contribute, this is the starting point!

But wait, are you asking... Where should I start?

The place where it starts

If you get to this point, you have my respect! You are using the tool, and that is awesome! Thanks!!

As a starting point, you need to create an issue. GitHub is awesome, and for a small project like this, the issue tracker is what we need (KISS, right?). Click on Issues tab on top, and open a issue (or use this link). Kick-off the discussion and the issue will be tagged accordingly.

This tool is technical, I'm a techie, and I will enhance it!

If you get this far, you heavily use the tool and that bug (sometimes we call it by design) annoys you. Well, it's OSS, and you want to left your mark, enhancing it.

Start forking the repo (assuming that you have a GitHub account). The guide will help you with the task. Then clone the repo:

git clone git@github.com:your-username/dotnet-project-dependencies-analyser.git

Setup your machine following this guide!

Make sure that it builds, and the tests pass:

  • On Windows: 
    ./build.ps1
  • On MacOSX/Linux: 
    ./build.sh

At this development stage, you can create your branch, or work on your master. This step is not a game changer. The project uses SemVer for release versioning.

Make your bug fix/feature enhancements, making sure the tests pass:

  • On Windows: 
    ./build.ps1
  • On MacOSX/Linux: 
    ./build.sh

Stage the changes:

git add <file(s)>

Commit the changes, giving a meaningful message:

git commit -m "My meaningful message"

Push the changes to origin:

git push origin <branch_name>

Then you create a Pull Request with a brief description of the PR. I will take a look ASAP (I'm using the tool, any enhancement is welcome), and will merge it. You have higher chances to be approved if: