Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add workflows & templates #31

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/suggestion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: Make a suggestion
about: Pose a question or point out an improvement/error
title: ''
labels: ''
assignees: ''

---

**Question/Suggestion:**
<!--A clear description of what you are asking/suggesting and why.-->
-
-
4 changes: 1 addition & 3 deletions .github/config.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# This file sets up the Configuration for many of the GitHub Actions and Automations used in this repository
# Based off the config.yml file used at TTW: https://github.com/the-turing-way/the-turing-way

#################### COMMUNITY BUILDING #####################
# To welcome new community members and support interactions
Expand All @@ -10,18 +11,15 @@
# Comment to be posted to on first time issues
newIssueWelcomeComment: >
:tada: Thanks for opening your first issue in the AIM RSF Synthetic Data repository! :tada:
[![Welcome Banner](https://zenodo.org/api/iiif/v2/0c0188d3-d03c-4830-a6e3-00405f5c22fa:8ff47a85-7250-4d86-8e48-2f346b48b2c1:BannerWelcome.jpg/full/750,/0/default.jpg)](https://zenodo.org/record/3695300)
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome

# Comment to be posted to on PRs from first time contributors in your repository
newPRWelcomeComment: >
[![Thank You Banner](https://zenodo.org/api/iiif/v2/0c0188d3-d03c-4830-a6e3-00405f5c22fa:7fbd97cf-283b-480c-b8e1-11866e26245c:BannerThanks.jpg/full/750,/0/default.jpg)](https://zenodo.org/record/3695300)
:sparkling_heart: Thanks for opening this pull request! :sparkling_heart: Make sure you have described what changes you've made and are suggesting, and then request someone to review the PR.
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge

# Comment to be posted to on pull requests merged by a first time user
firstPRMergeComment: >
[![Congratulations Banner](https://zenodo.org/api/iiif/v2/0c0188d3-d03c-4830-a6e3-00405f5c22fa:32fbdb89-ae1b-434e-830c-88ade86724cc:BannerCongratulations.jpg/full/750,/0/default.jpg)](https://zenodo.org/record/3695300)
Congrats on merging your first Pull Request! :tada:

# This Welcome is based on The Turing Way and the [behaviourbot's welcome](https://github.com/behaviorbot/welcome?installation_id=26730891&setup_action=install). Material from The Turing Way has been used and adapted under a CC-BY license. Attributions go to [The Turing Way Community. (2021). The Turing Way: A handbook for reproducible, ethical and collaborative research (1.0.1)](https://doi.org/10.5281/zenodo.6533831) Images from the Banners were created by Scriberia for The Turing Way community and are used under a CC-BY licence.
11 changes: 11 additions & 0 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Documentation:
- changed-files:
- any-glob-to-any-file: ['*.md']

Internal:
- changed-files:
- any-glob-to-any-file: ['.github/*','.all-contributorsrc']

# Testing:
# - changed-files:
# - any-glob-to-any-file: []
17 changes: 17 additions & 0 deletions .github/workflows/auto-author-assign.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Auto Author Assign

on:
issues:
types: [ opened, reopened ]
pull_request_target:
types: [ opened, reopened ]

permissions:
pull-requests: write
issues: write

jobs:
assign-author:
runs-on: ubuntu-latest
steps:
- uses: toshimaru/[email protected]
15 changes: 15 additions & 0 deletions .github/workflows/auto-label.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: auto-label
concurrency:
group: ${{ github.workflow }}-${{ github.event.number }}-${{ github.event.ref }}
cancel-in-progress: true
on: # yamllint disable-line rule:truthy
pull_request_target

jobs:
pr:
permissions:
contents: read
pull-requests: write
runs-on: ubuntu-latest
steps:
- uses: actions/labeler@v5
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Contributing to Synthetic-Data

We warmly welcome contributions to this Synthetic Data repository!
This document provides guidelines for contributing to this repository.

## How to Contribute

There is currently no code in this repository (17th July 2024) but there are still many ways you can contribute.

### Create an [Issue](https://github.com/aim-rsf/Synthetic-Data/issues) to:
- Point out an error (grammar, punctuation, factual)
- Suggest content be added to a section to expand or improve upon it
- Ask a question

### Making Changes

1. **Decide on the Issue to work on:** Ideally, the Issue you pointed out above. Feel free to look through other Issues and ask to work on them.
1. **Fork the Repository**: Start by forking the repository to your GitHub account.
2. **Create a Feature Branch**: Create a new branch for your change.
3. **Make Your Changes**: Implement your changes, adhering to any guidelines given.
4. **Test Your Changes**: Ensure your changes do not break any existing functionality.
5. **Submit a Pull Request**: Open a pull request from your feature branch to the main branch of the original repository.

## Questions or Need Help?

If you have questions or need help, feel free to open an issue for discussion or reach out to the maintainers directly.

Thank you for contributing to Synthetic-Data!
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ Thanks go to these wonderful people ([emoji key](https://allcontributors.org/doc

## 🤝 Would you like to contribute?

We welcome contributions from anyone, however small or large. If you choose to contribute to this synthetic data repository, please do this in line with our [code of conduct](https://github.com/aim-rsf/Getting-Started/blob/main/CODE_OF_CONDUCT.md). If you want to contribute but you're not sure where to start, see our [general guide to contributing](https://github.com/aim-rsf/Getting-Started/blob/main/CONTRIBUTING.md).
We welcome contributions from anyone, however small or large. Read our [contribution guidelines](CONTRIBUTING.md) for information on how to contribute, and please do so in line with our organisation [code of conduct](https://github.com/aim-rsf/Getting-Started/blob/main/CODE_OF_CONDUCT.md).

## ♻️ Licenses

Expand Down