Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 2.72 KB

CONTRIBUTING.md

File metadata and controls

63 lines (45 loc) · 2.72 KB

Contributing

First off, thank you for considering contributing to this project! It's people like you that make open source such a great community.

For a complete guide on how to contribute to open source projects on GitHub, please read the GitHub Open Source Guide.

🙌 How Can I Contribute?

🐞 Reporting Bugs

Before creating bug reports, please check the existing issues to avoid duplicates. When you create a bug report, include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps to reproduce the problem
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed and what behavior you expected
  • Include screenshots if possible
  • Include your environment details like OS, Browser, Docker, and Node.js version.

✨ Pull Requests

For a guide on how to open a pull request, please read this documentation from GitHub.

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. Ensure all the unit tests pass.
  4. Make sure your code passes the linter check.
  5. Make sure that the changes works in both Chrome and Firefox.
  6. Update the documentation if needed.
  7. Push to your fork and submit a pull request with the base branch set to master and the repository set to Screenly/Browser-Extension.

🚀 Release Process

Creating a Release

  • Generate a new release tag in git:
$ git pull
$ git checkout master
$ git tag
[...]
$ git tag -a vX.Y.Z -m "tl;dr changelog."
$ git push origin vX.Y.Z
  • Navigate to the GitHub releases and click 'Draft a new release'.
  • Select the tag you just created above and provide a release title and description.
    • You can use git diff v0.2.0..v0.3.0 to diff between the current and previous release to help you with the changelog.
  • Go to the CI Job and pull down the release .zip files for the release you created.
    • You can verify the .zip files you downloaded with the GitHub CLI by running gh attestation verify path/to/release.zip --owner Screenly.

Publishing to Stores

Chrome

Firefox

  • Navigate to Firefox's Add-on Developer Hub.
  • Upload screenly-firefox-extension.zip you downloaded before.