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

Discussion on how/when to merge fonts into the master branch #287

Closed
Thomas-Boi opened this issue Sep 9, 2020 · 4 comments
Closed

Discussion on how/when to merge fonts into the master branch #287

Thomas-Boi opened this issue Sep 9, 2020 · 4 comments
Labels
discussion Use this label for community discussions about changes/features/.. question Use this label for general questions not covered by another label

Comments

@Thomas-Boi
Copy link
Member

Hey @amacado,

I think that we should discuss on how we are going to merge fonts into the master branch from now on. Now that we have the build system, we can do batch updates instead of single changes. However, this means that we might have conflicts when merging or we might repeat fonts already added.

Perhaps we should create another readme for merging rules. This would be useful for future collaborators who would like to help us out. Beside that, we also need to work out a way to communicate who's merging which font/PR.

For the readme, it should list out things like:

  • How to add new icons to the devicon.json
  • What to do before pushing the changes: make sure files are in the icons folder
  • Possible issue (the task failing for the first couple times but work if you re-run it)

For the communication over which who's doing which PR/fonts, I think that we can use the GitHub Projects tab. I created an example board that you can check out and try. We can customize this to address issues as well.

Let me know what you think :)

@Thomas-Boi Thomas-Boi added discussion Use this label for community discussions about changes/features/.. question Use this label for general questions not covered by another label labels Sep 9, 2020
@amacado amacado mentioned this issue Sep 10, 2020
@amacado
Copy link
Member

amacado commented Sep 10, 2020

I support your ideas of defining a new workflow and enhancing the readme with information on how to collaborate. Regarding this topic I would propose to introduce a simple gitflow, where we do not merge feature branches (new icons) directly into the master branch but instead a new branch called develop. This would solve multiple problems:

  1. Currently our build action not working properly, because the master branch is write protected (if we would perform this action on a new non-protected develop branch this should work

image
(see https://github.com/devicons/devicon/runs/1090416932)

  1. More resilient release: We can test changes in the develop branch before releasing a new master version (when we integrate this in npm, what is on my list (npm release #288), this would improve our quality

See this image of gitflow-workflow:

image
(image taken from https://m.infos.seibert-media.net/Productivity/Git-Workflows+-+Der+Gitflow-Workflow.html)

I think I can work on this, if you approve, at the upcomming weekend, what do you think @Thomas-Boi ? :)

@Thomas-Boi
Copy link
Member Author

...we do not merge feature branches (new icons) directly into the master branch but instead a new branch called develop

I think that's a good idea. I think that will also fix the many failed build there were when people do PR :)

I can add the new rules to the CONTRIBUTING.md then (commit to develop instead of master, guide to use the build script). Besides that, I'd also like to get your feedback over how maintainers should communicate which tasks need to be done.

@amacado
Copy link
Member

amacado commented Sep 15, 2020

@Thomas-Boi I was busy last weekend so sorry for the delay. I hope to get up the "develop" branch this evening. Besides that: What do you think would be the improvement using the projects tab (i haven't worked with it yet)? Does the pull request/issue "assign to" method does not fit or is insufficient?

@Thomas-Boi
Copy link
Member Author

At the time that this question is created, I forgot that we as collaborators can assign tasks. I think that's a good enough way for us to divide PRs for merging.

So from now on, do we tell font contributors to create PR to develop instead of master? Or do we pull their branch to our local machine, merge into develop then push it to remote?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Use this label for community discussions about changes/features/.. question Use this label for general questions not covered by another label
Projects
None yet
Development

No branches or pull requests

2 participants