Skip to content

Latest commit

 

History

History
59 lines (33 loc) · 2.01 KB

CONTRIBUTING.md

File metadata and controls

59 lines (33 loc) · 2.01 KB

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

  1. Report Bugs

Report bugs at TA-mailclient repo via on Github.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.
  1. Fix Bugs

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

  1. Implement Features

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

  1. Write Documentation

TA-mailclient could always use more documentation. Feel free to add documentation for an undocumented feature.

  1. Submit Feedback

Please rate the app on Splunkbase You can also send feedback or submit an issue on Github.

Feature requests can also be submitted in the same way. Remember that this is a volunteer-driven project, and that contributions are welcome :)

This has been tested with Gmail, gmx.com, and a few other mail servers. You can also send a list of public mail servers that you use this without issues.

Feature requests are yet to be added to Github include the following:

  • Oath support for imap
  • Additional mailbox folder support for IMAP
  • Parameterization of mailbox limits for each run (currenlty set to 25)

I'm also working on integrating with Travis CI to allow automatic tests and continuous integration.

#Guidelines:

Please fork the repo on Github and create a branch for local changes. Create a pull request to the development branch.

Thanks again for volunteering 😃

Also remember to add your name to the list of contributors in AUTHORs.md