Skip to content

Commit

Permalink
Merge branch 'main' of github.com:tattle-made/Uli into main
Browse files Browse the repository at this point in the history
  • Loading branch information
dennyabrain committed Oct 12, 2023
2 parents 043c29e + 6860c23 commit 64c0b84
Show file tree
Hide file tree
Showing 46 changed files with 2,325 additions and 1,100 deletions.
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

72 changes: 72 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug", "triage"]
projects: ["tattle-made/uli"]
assignees:
- dennybrain
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: description
attributes:
label: Describe the bug
description: Write A clear and concise description of what the bug is.
placeholder: A bug happened!
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: Steps to reproduce
description: Steps to reproduce the behavior
placeholder: "1. Go to '...' \n2. Click on '....' \n3. Scroll down to '....' \n4. See error"
validations:
required: true
- type: input
id: expected
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
placeholder: I expected...
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: If applicable, add screenshots to help explain your problem
validations:
required: false
- type: dropdown
id: browsers
attributes:
label: What browsers are you seeing the problem on?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
- Other
- type: dropdown
id: os
attributes:
label: Which operating system are you on?
multiple: false
options:
- Windows
- MacOS
- Linux
- Android
- iOS
- type: textarea
id: system
attributes:
label: System Description
description: More information about your setup
validations:
required: false
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Feature request
description: Suggest an idea for this project
title: "Feature request"
labels: ["enhancement"]
projects: ["tattle-made/uli"]
assignees:
- dennybrain
body:
- type: textarea
id: problem
attributes:
label: Is your feature request related to a problem? Please describe.
description: A clear and concise description of what the problem is.
placeholder: Ex. I'm always frustrated when..
validations:
required: true
- type: textarea
id: solution
attributes:
label: Describe the solution you would like
description: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you have considered.
validations:
required: false
- type: textarea
id: additional_context
attributes:
label: Addtional Context
description: Add any other context or screenshots about the feature request here.
validations:
required: false
18 changes: 0 additions & 18 deletions .github/ISSUE_TEMPLATE/qa_test_checklist.md

This file was deleted.

42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/qa_test_checklist.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: QA Test Checklist
description: Use this as a guide for manual QA
title: "[QA]"
labels: ["qa"]
projects: ["tattle-made/uli"]
assignees:
- dennybrain
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: dropdown
id: browsers
attributes:
label: What browsers are you seeing the problem on?
multiple: true
options:
- Firefox
- Chrome
- Brave
- Microsoft Edge
- Other
- type: checkboxes
id: features
attributes:
label: Features to check
options:
- label: Users are able to archive a tweet on their device
- label: Users are able to send an archived tweet to their email
- label: Users are able to hide tweets with OGBV on their feed
- label: Users are able to update their Preference
- label: Uli is able to hide slurs on user's feed
required: false
- type: textarea
id: additional_context
attributes:
label: Something other than a feature?
description: QA testing for something else than a feature.
placeholder: Example, problem in viewing the image logo
validations:
required: false
65 changes: 65 additions & 0 deletions .github/workflows/build-pr-review-both-browsers.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: "Build For PR Review - Both Browsers"

on:
pull_request:
branches:
- main

permissions:
actions: write
issues: write
pull-requests: write
contents: write
repository-projects: write

jobs:
chrome-publish:
name: "Build For PR Review"
runs-on: "ubuntu-latest"

steps:
- name: "Checkout Development Branch"
uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.sha }}

- name: Get commit SHA
shell: bash
run: |
echo "setting variables"
echo "::set-output name=sha_short::$(git rev-parse --short HEAD)"
- name: "Build and Test"
run: |
cd browser-extension/plugin
ls
pwd
npm install
npm run build
mv dist/ extension-chrome/
npm run build:firefox
mv dist/ extension-firefox/
- name: "Upload dist folder as artifact"
uses: actions/upload-artifact@v3
with:
name: extension-artifacts
path: |
browser-extension/plugin/extension-firefox/
browser-extension/plugin/extension-chrome/
# - name: Debug GitHub Token Permissions
# run: echo ${{ secrets.GITHUB_TOKEN }}

# - name: Create PR Comment with Artifact Link
# uses: actions/github-script@v5
# with:
# github-token: ${{ secrets.GITHUB_TOKEN }}
# script: |
# const artifact_url = `https://github.com/${{github.repository_owner}}/${{github.event.repository.name}}/actions/runs/${{ github.run_id }}`;
# const comment_body = `🛠 Your build files are available [here](${artifact_url}).`;
# await github.rest.issues.createComment({
# issue_number: context.payload.pull_request.number,
# owner: context.repo.owner,
# repo: context.repo.repo,
# body: comment_body
# });
25 changes: 12 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,13 @@

Firstly we are really grateful to you that you are considering contributing to Uli. We welcome contributions of all sorts - filing a bug report, suggesting improvements, proposing new feature, adding documentations, writing tests etc.

By contributing to Uli, you are agreeing to our community guidelines (will be linked soon)
By contributing to Uli, you are agreeing to our [community guidelines](https://github.com/tattle-made/Uli/blob/main/CODE_OF_CONDUCT.md)

Contributing to Uli takes 4 easy steps

👋 Say Hi

🔨 Do your thing

📞 Tell us

👋 Say Hi
🔨 Do your thing
📞 Tell us
🎉 Celebrate

---
Expand All @@ -20,21 +17,23 @@ Contributing to Uli takes 4 easy steps

The very first thing you should do is letting us know that you are interested in contributing by the following means :

If you are unsure about how to contribute to Uli, simply join our slack and introduce yourself and mention what interests you about the project. We'll reach out and assist you further.
If you are unsure about how to contribute to Uli, simply join our [slack](https://admin417477.typeform.com/to/nVuNyG?typeform-source=tattle.co.in), introduce yourself and mention what interests you about the project. We'll reach out and assist you further.

If there's a particular improvement you want to suggest, or a bug in kosh you want to fix, simply create a Github Issue regarding it and we'll reach out to assist you further.
If there's a particular improvement or feature you want to suggest, or a bug in Uli you want to fix, simply create a Github Issue regarding it and we'll reach out to assist you further.

If you are interested in knowing what we are working on right now, head over to the [project page](https://github.com/orgs/tattle-made/projects/30). If any issue there interests you, comment on it for any clarification.

If you are leaning towards working on our codebase, you might find our [learning guide](https://github.com/tattle-made/Uli/wiki/Uli-Learning-Guide) useful. This will help you expedite whatever you need to learn to be an effective contributor.

# 🔨 Do your thing
You should be able to run Uli on your own machine by following the instructions [here](../README.md). Find a github issue and make changes in the codebase to address the issue.
You should be able to run Uli on your own machine by following the instructions on one of our [setup guides](https://github.com/tattle-made/Uli/wiki/Setup-Uli-on-Linux-for-Chrome). If you prefer, we have a [video tutorial](https://www.youtube.com/watch?v=fwSnEe3-fL8) as well. Once you have identified the issue you want to work on, make a fork of our repository and get to coding.


## Pair programming

We offer pair programming sessions with community members to familiarize them with the product and the code base. This will give you an opportunity to clarify any doubts regarding the codebase and the features that interest you.
We offer pair programming sessions with community members to familiarize them with the product and the code base. This will give you an opportunity to clarify any doubts regarding the codebase and the features that interest you. Do ping us on the issue or on slack if you would like to sign up for it.

# 📞 Tell us
# 📞 Tell us via Pull Request

All code changes happen via pull request. We use [Github Flow](https://guides.github.com/introduction/flow/). The easiest way to let us know if you want to combine your changes into the core code is to make a Pull Request (PR)

Expand All @@ -47,7 +46,7 @@ We don't strictly follow test driven development (TDD) but any contributions tha

# 🎉 Celebrate

We typically review a PR within 2-3 days. We might offer you some feedback to your PR and merge it! If you reached till this stage, Congratulations and join us afterwards for virtual coffee/tea on slack 🙂
We typically review a PR within 2-5 days. We might offer you some feedback to your PR and merge it! If you reached till this stage, Congratulations and join us afterwards for virtual coffee/tea on slack 🙂

# Licence

Expand Down
Loading

0 comments on commit 64c0b84

Please sign in to comment.