mesg-foundation / js-sdk

Javascript mono-repo with all the tools to interact with MESG
https://mesg.com
4 stars 4 forks source link

Create template and validation for pull request #154

Closed antho1404 closed 4 years ago

antho1404 commented 4 years ago

We should create a template for Pull request with a checklist to make sure all necessary information is present. We should also run some Github action to ensure that the requirements match.

List of things needed in the checklist of the PR:

Example of Pull Request templates:

List of things that require validation through a Github action or external service.

If we can do the last step, to syncronize the changelog to the labels, then we don't need to add it in the checklist.

Man-Jain commented 4 years ago

Hey, I have started the work for Github Action. For now I am done with the Label with the right library present (one of the tags that starts with @mesg/). Although I am not quite able to make out what to do with description of PR and changelog one. It would be great if you could elaborate those. Will update the status once it is completed

antho1404 commented 4 years ago

The description is just to make sure that every pull request has a description (but if the template is clear enough we shouldn't have any problem and the validation might not be necessary).

The changelog is already done with this PR https://github.com/mesg-foundation/js-sdk/pull/166, this is to ensure that every pull request has an update on the changelog (and should be one of the item in the PR template checklist).

The complicated part is to syncronize that the actual changelog entries are correlated with the right tags on the pull request (or added automatically) so like that every time we add a new entry on the changelog (let's say for a breaking change) we would have the label breaking change on the pull request.

Let me know if you have more questions.

Man-Jain commented 4 years ago

I did some research on the labeling PRs from Github Action. Looks like we cant use a Github Action to add labels to a PR from a fork. This can be seen here https://github.com/actions/labeler/issues/12 Will this be a problem for our implementation ?

antho1404 commented 4 years ago

This is not ideal but as long as it works one the repository it should be fine. We can find solutions later to make it work for forks too (or they will probably fix this soon). You can continue on that, it will be fine except if you find a solution that works even for forks)

Man-Jain commented 4 years ago

It is working now for that and I'll submit the work for it. Other solutions would require the bot to be hosted somewhere and work using a webhook. If you have any other solutions in mind please share them and I'll take a look at those.

gitcoinbot commented 4 years ago

@jean-phillipe88 Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

jean-phillipe88 commented 4 years ago

Has this issue been resolved?

antho1404 commented 4 years ago

No, the issue is still open

jean-phillipe88 commented 4 years ago

@gitcoinbot not working on it.

antho1404 commented 4 years ago

no this is the bot that connects to gitcoin but doesn't do any work ;)

gitcoinbot commented 4 years ago

@jean-phillipe88 Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

gitcoinbot commented 4 years ago

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


@jean-phillipe88 due to inactivity, we have escalated this issue to Gitcoin's moderation team. Let us know if you believe this has been done in error!

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

antho1404 commented 4 years ago

Issue migrated to liteflow-labs/liteflow-js#68