Skip to content

hizzle-co/noptin

Repository files navigation

Noptin - Fastest WordPress Newsletter Plugin

Commits to deploy build status languages code size repo size Monthly Downloads License Rating Version Website

Welcome to the Noptin repository on GitHub. Here, you can report bugs, request for new features and enhancements and follow the development of the plugin.

If you want to install this plugin on a live website, please use the Noptin plugin page on WordPress.org.

Contributing

Contributing isn't just writing code - it's anything that improves the project. All contributions for Noptin are managed right here on GitHub.

Here are some ways you can help:

Reporting bugs

If you're running into an issue with the plugin, please use our issue tracker to open a new issue. If you're able, include steps to reproduce, environment information, and screenshots/screencasts as relevant. Do not use the issue tracker for support requests. For that, checkout our contact form.

Suggesting enhancements

New features and enhancements are also managed via issues.

Write and submit a patch

If you'd like to fix a bug or make an enhancement, you can submit a Pull Request.

To do this:-

  1. Fork this repo on GitHub.
  2. Make the changes you want to submit.
  3. Create a new pull request.

By contributing your code, you are helping us create a better, more reliable WordPress plugin. As a result, your website (along with hundreds of other websites) can benefit from having better newsletter subscription forms.

Workflow

The master branch is the development branch which means it contains the next version to be released. stable contains the current latest release and stable-dev contains the corresponding stable development version. Always open up PRs against master.

Release instructions

  1. Merge changes: Merge all changes into master and ensure that Travis CI does not produce any fatal errors.
  2. Version bump: Bump the version numbers in noptin.php and readme.txt if it does not already reflect the version being released.
  3. Update Changelog: Update the changelog in readme.txt
  4. Localize: Update the language files.
  5. Clean: Check to be sure any new files/paths that are unnecessary in the production version are included in .gitattributes.
  6. Merge into stable: Make a non-fast-forward merge from master into stable. stable contains the latest stable version.
  7. Test: Check out the stable branch and test for functionality locally.
  8. Release on GitHub: Create a new GitHub release and copy the changelog for the release into the Release body. Create a tag for the release as X.Y.Z then publish the release. Users will now be able to update the plugin from their WordPress dashboards.

NOTE: After each release, merge the stable branch into the stable-dev branch. Urgent fixes will go into the stable-dev branch and released ASAP.

Support Level

Active: Noptin is actively working on this, and we expect to continue work for the foreseeable future including keeping tested up to the most recent version of WordPress. Bug reports, feature requests, questions, and pull requests are welcome.