Skip to content

Latest commit

 

History

History
115 lines (69 loc) · 2.86 KB

CONTRIBUTING.rst

File metadata and controls

115 lines (69 loc) · 2.86 KB
Raw

Contributing

Contribution is always welcome and appreciated. Feel Free to submit issues or pull requests by following the guide below.

Report A Bug

Report bugs at https://github.com/saadmk11/django-newsfeed/issues.

Please include these on your bug report:

  • How you came across this bug.
  • Details about your local setup.
  • Version of python and django you are using.
  • Traceback of the error (if any).

Write Documentation

If you find anything that may require more explaining or is not documented feel free to update it and submit a pull request.

Request A New Feature

You can add your feature request here.

Please include these on your feature request:

  • Detailed information of your feature request.
  • Explain how it will work.

Fix Bugs

Look through the GitHub issues for bugs. If you find anything you want to work on feel free to get started on it.

Implement A Feature

If you find any issue on the projects GitHub issues with Feature tag and you want to implement it you are more than welcome to leave a comment on the issue we will get back to you soon.

Give Feedback

If you are using this package we would love to know your experience and suggestions. You can open a GitHub issues and we can talk more about it. Feedbacks are always appreciated.

Setting up the project for development

Follow the steps below to set up django-newsfeed locally.

  1. Fork django-newsfeed repository on GitHub.

    https://github.com/saadmk11/django-newsfeed

  2. Clone the forked repository on your local machine:
$ git clone git@github.com:<your-github-username>/django-newsfeed.git
  1. change directory to django-newsfeed and install django-newsfeed inside a virtualenv:
$ mkvirtualenv django-newsfeed     # you can use virtualenv instead of virtualenvwrapper
$ cd django-newsfeed/
$ python setup.py develop

4 Setup and Run the development server:

$ python manage.py migrate
$ python manage.py runserver       # http://127.0.0.1:8000/
  1. Create a new branch for local development:
$ git checkout -b <your-new-branch-name>
  1. Make the changes you need. Include tests if you have made any changes to the code.
  2. Run tests to make sure everything is working properly:
$ tox

run pip install tox if its not already installed in your machine

  1. Commit the changes and push it to GitHub:
$ git add .
$ git commit -m "<Commit message about the changes you made>"
$ git push <your-new-branch-name>
  1. Create a pull request to django-newsfeed