Skip to content

Latest commit

 

History

History
71 lines (55 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

71 lines (55 loc) · 1.86 KB
Raw

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs on the `issues page`_. If you are reporting a bug, please include:

* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug"
is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "feature"
is open to whoever wants to implement it.

Write Documentation

This module could always use more documentation, whether as part of the
official docs, in docstrings, or other.

Submit Feedback

The best way to send feedback is to file an ticket on the `issues page`_. If you
are proposing a feature:

* Explain how it would work.
* Keep the scope as narrow as possible, to make it easier to implement.
* Remember that this is a volunteer-driven project, and that contributions
  are welcome :)

Get Started!

Ready to contribute? Here's how to set up Hackerrank-Solution-Crawler for local development.

  1. Fork the Hackerrank-Solution-Crawler repo on GitHub.
  2. Clone your fork locally::
    $ git clone [email protected]:Nullifiers/Hackerrank-Solution-Crawler.git
  1. Create a branch for local development::
    $ git checkout -b name-of-your-bugfix-or-feature
  1. Commit your changes, quoting github issue in the commit message, if applicable and push your branch to GitHub::
    $ git add .
    $ git commit -m "Fix #XX - My awesome fix"
    $ git push origin name-of-your-bugfix-or-feature
  1. Submit a pull request through the GitHub website.