Default community files

Default community files used in all of the vidavidorra organisation's projects.

• Roadmap for the vidavidorra organisation's projects.
• Reusable GitHub Actions workflows.
• GitHub issue and pull request templates.
• Renovate configuration preset.
• Contributing guidelines.

---

• Usage
  • Reusable GitHub Action workflows
  • Renovate
  • Contributing guidelines
• Contributing
• Security policy
• License

Usage

Reusable GitHub Action workflows

Most of the workflows in the .github/workflows folder are reusable workflows. Please see each individual workflow file for it's specific usage and possible inputs. The following example shows the most basic usage in the lint job, as well as a little bit more advance usage, with workflow inputs, in the build job. Please see the Calling a reusable workflow section of the GitHub documentation for more details.

jobs:
  lint:
    uses: vidavidorra/.github/.github/workflows/node-lint.yml
  build:
    strategy:
      matrix:
        nodeVersion: [18, 20]
    uses: vidavidorra/.github/.github/workflows/node-build.yml
    with:
      nodeVersion: ${{ matrix.nodeVersion }}

Renovate

To use the configuration preset, inlcude github>vidavidorra/.github in the extends array of the Renovate configuration, as per its documentation.

{
  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
  "extends": ["github>vidavidorra/.github"]
}

Contributing guidelines

In the section on contributing of the project's readme, refer to the contributing guidelines of this repository. The following text shows an example of such reference.

Refer to the contributing guide for detailed information about other contributions, like pull requests.

Refer to the [contributing guide](https://github.com/vidavidorra/.github/blob/main/CONTRIBUTING.md) for detailed information about other contributions, like pull requests.

Contributing

Please create an issue if you have a bug report or feature proposal, or create a discussion if you have a question. If you like this project, please consider giving it a star ⭐

Refer to the contributing guide for detailed information about other contributions, like pull requests.

Security policy

Please refer to the Security Policy on GitHub for the security policy.

License

This project is licensed under the GPLv3 license.

Copyright © 2020-2024 Jeroen de Bruijn

License notice

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

The full text of the license is available in the LICENSE file in this repository and online.