Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

43 lines (27 loc) · 2.53 KB

Contribution guidelines

First of all, thanks for thinking of contributing to this project. 😄

Before sending a Pull Request, please make sure that you're assigned the task on a GitHub issue.

  • If a relevant issue already exists, discuss on the issue and get it assigned to yourself on GitHub.
  • If no relevant issue exists, open a new issue and get it assigned to yourself on GitHub.

Please proceed with a Pull Request only after you're assigned. It'd be a waste of your time as well as ours if you have not contacted us before hand when working on some feature / issue. You can contact us on the slack group: https://girlscriptgssoc.slack.com/messages/CB4V6N62H/details/ or on relevant issues itself. We welcome any contribution that could enhance app's functionality. Kindly follow the simple steps below to submit a Pull Request.

Development

  1. Fork this repo and clone the forked repo locally.

  2. Install with

    git clone https://github.com/kaustubhhiware/facebook-archive.git
cd facebook-archive
git remote set-url upstream https://github.com/kaustubhhiware/facebook-archive.git
git remote set-url origin https://github.com/[your_username]/facebook-archive.git
sudo chmod a+x run.sh # only for the first time

  3. Make a seperate branch with a descriptive name (that could explain the purpose of the PR) such as awesome_feature and switch to it by running git checkout -b your_branch(here, awesome_feature) in the terminal.

  4. Add/Modify the code and do git add files_involved to add your changes.

  5. Commit your changes using git commit -am "your_message". Please refer to commit message guidelines to write better commit messages. It will help in an easier review process.

  6. Do git pull upstream master to sync with this repo.

  7. Do git push origin your_branch(here, awesome_feature) to push code into your branch.

  8. Finally, create a PR by clicking on the New pull request button here.

ToDos

These are the things to note, irrespective of what issue you are working on.

  • Pick larger intervals to plot for clearer graphs, less shaky.
  • Make sure the scripts are compatible with the latest version of JSON data provided by facebook's archive - #2.
  • Document all functions, use docstrings, intuitive variable names - #16.