Contributing to Pocket Archive

Pocket Archive is, and will remain, a free tool for people of modest means. This implies that voluntary contributions to the project are very welcome at any time. These contributions can come in a variety of ways:

  • Installing, configuring, and using the software, providing feedback about its functionality, and/or reporting issues;
  • Reading the documentation, and providing feedback about its accuracy, readability, and reporting out-of-date information;
  • Contributing to improving and maintaining the code;
  • Contributing test data and/or writing tests.

All contributions are made via the source repository. Note that an account is required to open issues or otherwise contribute. At the moment the site is being set up and is not accepting new accounts. Hang on tight.

Contributing guidelines

As stated elsewhere, Pocket Archive strives to be simple and flexible, for both the maintainer and the user. These are not easy goals to keep at the same time; therefore, new feature requests or improvements are evaluated for suitability with the project goals, and if a reasonable path to resolve a specific problem with pre-existing method exists, that will be suggested rather than adding new code.

Please create an issue before sending a merge request, so that your problem can be discussed and understood before spending time in writing and reviewing code.