Contributing to the project

Please take a moment to review this document in order to make the contribution
process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of
the developers managing and developing this open source project. In return,
they should reciprocate that respect in addressing your issue, assessing
changes, and helping you finalize your pull requests.

As for everything else in the project, the contributions to this project are governed by our our team.

Using the issue tracker

First things first: Do NOT report security vulnerabilities in public issues! Please disclose responsibly by letting [the this project team](mailto:team@thethis projectfirm.com?subject=Security) know upfront. We will assess the issue as soon as possible on a best-effort basis and will give you an estimate for when we have a fix and release available for an eventual public disclosure.

The issue tracker is the preferred channel for bug reports,
features requests and submitting pull
requests, but please respect the following restrictions:

• Please do not use the issue tracker for personal support requests. Use
  the this project Chat.

• Please do not derail or troll issues. Keep the discussion on topic and
  respect the opinions of others.

Bug reports

A bug is a demonstrable problem that is caused by the code in the repository.
Good bug reports are extremely helpful - thank you!

Guidelines for bug reports:

1. Use the GitHub issue search — check if the issue has already been
   reported.

2. Check if the issue has been fixed — try to reproduce it using the
   latest master or next branch in the repository.

3. Isolate the problem — ideally create a reduced test case.

A good bug report shouldn't leave others needing to chase you up for more
information. Please try to be as detailed as possible in your report. What is
your environment? What steps will reproduce the issue? What OS experiences the
problem? What would you expect to be the outcome? All these details will help
people to fix any potential bugs.

Example:

Short and descriptive example bug report title

A summary of the issue and the browser/OS environment in which it occurs. If
suitable, include the steps required to reproduce the bug.

1. This is the first step
2. This is the second step
3. Further steps, etc.

<url> - a link to the reduced test case

Any other information you want to share that is relevant to the issue being
reported. This might include the lines of code that you have identified as
causing the bug, and potential solutions (and your opinions on their
merits).

Feature requests

Feature requests are welcome. But take a moment to find out whether your idea
fits with the scope and aims of the project. It's up to you to make a strong
case to convince the project's developers of the merits of this feature. Please
provide as much detail and context as possible.

Pull requests

Good pull requests - patches, improvements, new features - are a fantastic
help. They should remain focused in scope and avoid containing unrelated
commits.

Please ask first before embarking on any significant pull request (e.g.
implementing features, refactoring code), otherwise you risk spending a lot of
time working on something that the project's developers might not want to merge
into the project.

For new Contributors

If you never created a pull request before, welcome 🎉 😄 Here is a great tutorial
on how to send one :)

1. Fork the project, clone your fork,
   and configure the remotes:

   # Clone your fork of the repo into the current directory
   git clone https://github.com/<your-username>/<repo-name>
   # Navigate to the newly cloned directory
   cd <repo-name>
   # Assign the original repo to a remote called "upstream"
   git remote add upstream https://github.com/this projecthq/<repo-name>

2. If you cloned a while ago, get the latest changes from upstream:

   git checkout master
   git pull upstream master

3. Create a new topic branch (off the main project development branch) to
   contain your feature, change, or fix:

   git checkout -b <topic-branch-name>

4. Make sure to update, or add to the tests when appropriate. Patches and
   features will not be accepted without tests. Run npm test to check that
   all tests pass after you've made changes. Look for a Testing section in
   the project’s README for more information.

5. If you added or changed a feature, make sure to document it accordingly in
   the README.md file.

6. Push your topic branch up to your fork:

   git push origin <topic-branch-name>

7. Open a Pull Request
   with a clear title and description.

For Members of the this project Contributors Team

1. Clone the repo and create a branch

   git clone https://github.com/this projecthq/<repo-name>
   cd <repo-name>
   git checkout -b <topic-branch-name>

2. Make sure to update, or add to the tests when appropriate. Patches and
   features will not be accepted without tests. Run npm test to check that
   all tests pass after you've made changes. Look for a Testing section in
   the project’s README for more information.

3. If you added or changed a feature, make sure to document it accordingly in
   the README.md file.

4. Push your topic branch up to our repo

   git push origin <topic-branch-name>

5. Open a Pull Request using your branch with a clear title and description.

Optionally, you can help us with these things. But don’t worry if they are too
complicated, we can help you out and teach you as we go :)

1. Update your branch to the latest changes in the upstream master branch. You
   can do that locally with

   git pull --rebase upstream master

   Afterwards force push your changes to your remote feature branch.

2. Once a pull request is good to go, you can tidy up your commit messages using
   Git's interactive rebase.
   Please follow our commit message conventions shown below, as they are used by
   semantic-release to
   automatically determine the new version and release to npm. In a nutshell:

   Commit Message Conventions

   • Commit test files with test: ... or test(scope): ... prefix
   • Commit bug fixes with fix: ... or fix(scope): ... prefix
   • Commit breaking changes by adding BREAKING CHANGE: in the commit body
     (not the subject line)
   • Commit changes to package.json, .gitignore and other meta files with
     chore(filenamewithoutext): ...
   • Commit changes to README files or comments with docs: ...
   • Cody style changes with style: standard

IMPORTANT: By submitting a patch, you agree to license your work under the
same license as that used by the project.

Triagers

There is a defined process to manage issues, because this helps to speed up releases and minimizes user pain.
Triaging is a great way to contribute to this project without having to write code.
If you are interested, please [leave a comment here](https://github.com/this projecthq/discussion/issues/50) asking to join the triaging team.

Maintainers

If you have commit access, please follow this process for merging patches and cutting new releases.

Reviewing changes

1. Check that a change is within the scope and philosophy of the component.

2. Check that a change has any necessary tests.

3. Check that a change has any necessary documentation.

4. If there is anything you don’t like, leave a comment below the respective
   lines and submit a "Request changes" review. Repeat until everything has
   been addressed.

5. If you are not sure about something, mention @this project/maintainers or specific
   people for help in a comment.

6. If there is only a tiny change left before you can merge it and you think
   it’s best to fix it yourself, you can directly commit to the author’s fork.
   Leave a comment about it so the author and others will know.

7. Once everything looks good, add an "Approve" review. Don’t forget to say
   something nice 👏🐶💖✨

8. If the commit messages follow our conventions

   1. If there is a breaking change, make sure that BREAKING CHANGE: with
      exactly that spelling (incl. the ":") is in body of the according
      commit message. This is very important, better look twice :)
   2. Make sure there are fix: ... or feat: ... commits depending on wether
      a bug was fixed or a feature was added. Gotcha: look for spaces before
      the prefixes of fix: and feat:, these get ignored by semantic-release.
   3. Use the "Rebase and merge" button to merge the pull request.
   4. Done! You are awesome! Thanks so much for your help 🤗

9. If the commit messages do not follow our conventions

   1. Use the "squash and merge" button to clean up the commits and merge at
      the same time: ✨🎩
   2. Is there a breaking change? Describe it in the commit body. Start with
      exactly BREAKING CHANGE: followed by an empty line. For the commit
      subject:
   3. Was a new feature added? Use feat: ... prefix in the commit subject
   4. Was a bug fixed? Use fix: ... in the commit subject

Sometimes there might be a good reason to merge changes locally. The process
looks like this:

Reviewing and merging changes locally

git checkout master # or the main branch configured on github
git pull # get latest changes
git checkout feature-branch # replace name with your branch
git rebase master
git checkout master
git merge feature-branch # replace name with your branch
git push

When merging PRs from forked repositories, we recommend you install the
hub command line tools.

This allows you to do:

hub checkout link-to-pull-request

meaning that you will automatically check out the branch for the pull request,
without needing any other steps like setting git upstreams! ✨

Ability to save pages into ePUB files.

There is an extension that does it already even though not perfectly http://sparika.github.io/Firefox-html-to-epub/

These web pages cause the extension to pause and sometimes crash:
http://www.orionmediagroup.co.uk/ (all sites linked do not save)
http://www.reddragonfm.co.uk/
http://www.heartessex.co.uk
http://www.heartpeterborough.co.uk
http://www.heartkent.co.uk
http://www.heartsussex.co.uk
http://www.heartnorwich.co.uk
http://www.heartcambridge.co.uk
http://www.ten17.co.uk
http://www.capitalfm.com
http://www.heartbournemouth.co.uk
http://www.hearthampshire.co.uk
http://www.mercuryfm.co.uk
http://www.leicestersound.co.uk
http://www.trentfm.co.uk
http://www.ramfm.co.uk
http://www.heartgloucestershire.co.uk
http://www.heartbristol.co.uk
http://www.canadiandriver.com

All of these sites did not save properly with the extension, and no matter how many times I tried, they did not work.

Also, a suggestion - maybe enable the user to save a page as the default extension (e.g.
mypage1.asp can be saved as it is, rather than becoming mypage1.asp.html)

Please investigate this bug, thanks!

This add-on is great. I use it all the time. Pretty please update to be firefox 4 compatible.

Saving the site http://www.DelaverianMarketing.com works oddly.

The only way to save the image files is to turn on General -> Adjust links [Experimental]

Also I'd vote for saving all files to a folder with the toplevel file named index.html so a save is self contained (if it moves, it always works). And if the folder is dropped on a Web server, it can be viewed online if required.

Great add-on! Definitely the only sane way to save files in FireFox!

Keep up your Great Work!

• David

Many pages use javascript after the page loads to make modifications, and many of these pages no longer work after being saved. Create a file provider that takes the HTML from the current page rather than downloading it from the server or pulling from cache.

Thanks for making this plugin! Here's some pages which don't work for me. Hopefully you can fix it. :)

http://iteslj.org/v/k/kre-people.html
http://iteslj.org/v/k/kre-people_b.html

If you can get those to work, then probably all the links on this page will work: http://iteslj.org/v/k/

Extension should be more accurately named 'save with CSS'?

Example is page:
http://www.bakabt.com/153224-ikkitousen-xtreme-xecutor-480p-h264-ryuumaru-commie.html
It displays normally (though you must have javascript on) in the browser,
but when saved with save-complete (or regular save), it's missing the central
image and the description.

Most of the pages on that site have the same problem.

Perhaps as an example to fix the problem, the extension 'ScrapBook', DOES pull down the whole page (but stores it all in one dir -- no 'file' + support files-in dir)

Would be great if you could get this extension to really save complete :-).

Thanks.

If the url has hash text, then that will show up in the suggested file name in the save dialog. Remove everything after the "#" from the suggested file name before appending the extension.

Hi ,
Please check doesnt seem to be working very well with :
http://www.synergyenviron.com

And Firefox also has Web Page ,Complete under Save As type thing.

Regards

Will there be an upgrade to FF 47.0 anytime soon? I really like this addon and miss it when it is not available.

Thanks.

When a web page is saved as doc.title+".html" (main.js line #117), the title may contain characters not belonging the current download.charset, so I suppose they must be escaped in scPageSaver.scDefaultFileSaver.prototype.documentPath function as it has been done with spaces at the lines #714, #716 in saver.js.
Example url: https://bugzilla.redhat.com/show_bug.cgi?id=480339
The hyphen in the title of this page is a UTF-8 not ISO-8859-1 character, so if one choose latter character encoding for this page an save it, the hypen in the fixed tag will be replaced to "?" in the scPageSaver.scDefaultFileSaver.prototype.saveURIContents function.

Please add the option to chose the style of the name of page being saved: page title or its url. Thanks.

I sometimes save pages with their default extensions so I can use them for testing/development in Apache/IIS, e.g. mysite.com/test1.php or mysite2.com/test2.asp and would like to save them as their default extension without having to rename the file after saving it every time to be the relevant extension.

That's the only workaround I found that seemed to work for me, but there's currently no other way of doing this.

I have heard some programmers use this extension to test how well their pages save from Firefox.

Please look into this, it may be worth investigation.

'Save complete' breaks on http://elementy.ru/lib/430825/430828?page_design=print
Images aren't saved properly!
It was the first time i used this addon and it didn't work at that moment:-(

p.s.: ver. 1.0.1, FF3.5

Hey, I will give you format just write rest of the content.

Project Title

One Paragraph of project description goes here

Getting Started

These instructions will get you a copy of the project up and run on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Give examples

Installing

A step by step series of examples that tell you have to get a development env running

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built With

• Dropwizard - The web framework used
• Maven - Dependency Management
• ROME - Used to generate RSS Feeds

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Billie Thompson - Initial work - PurpleBooth

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• Hat tip to anyone who's code was used
• Inspiration
• etc