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

Updating CREDITS.md as teams evolve #6

Open
asirota opened this issue Nov 3, 2024 · 4 comments
Open

Updating CREDITS.md as teams evolve #6

asirota opened this issue Nov 3, 2024 · 4 comments

Comments

@asirota
Copy link
Member

asirota commented Nov 3, 2024

AspirePress is a fast moving project and contribution to project change. The CREDITS.md file can reflect more accurately the team structure by pointing to the GitHub contributors list on each repository. That could be a more accurate up to date representation on team composition.

Since this document is linked off the home page of the docs.AspirePress.org website it should be as up to date as possible.

@yosefeliezrie
Copy link

yosefeliezrie commented Nov 4, 2024

Initially looking at this I was thinking we should perhaps do something manually with someone updating both the credits and contributor list on a regular basis either once pull request come through or
With each release.

I have also been looking into same automated options for contributors:

Because we have multiple repository's we would need a way to sync all credits and contributors to one file or link to each repositories contributors.

Another important point with using something automated is probably best but contributing isn’t limited to just code, and many things are not happening GitHub.

We have amazing people contributing in ways that best fits their unique abilities including helping with design, infra, docs, architecture, project management, working on our documentation and much more. If we are using an automated process for contributors and credits we will need a way to include those people as well. This also underpins that perhaps we should centralise all work and discussions into one place beyond slack better using the features of GitHub discussions or using other dedicated software.

These are just a few thoughts, please let me know what you think. Thanks!

@asirota
Copy link
Member Author

asirota commented Nov 4, 2024

It would be really nice to include everyone who contributes but for example doing host outreach would be pretty hard to track on GitHub would it not? And probably not everyone would want to learn Git to contribute. Why don't we keep the credits simply to code and documentation level changes.

This way we can just point to the contributors who have contributed to the AspirePress project and leave it at that for now. That could just be a link to https://github.com/orgs/aspirepress/people

Mind you People are set to private so if they want the public GitHub view to show them they'll have to set their profile to public. But that's up to them really.

@yosefeliezrie
Copy link

I was working on something else and noticed this from the a11yproject.com. They store their sponsors, team, contributors etc in JSON and than use than to display on their site. https://github.com/a11yproject/a11yproject.com/tree/main/src/_data I would assume we can also automate portions of this and than have that data populate a page on the website or in the .github repo..

Just relying on the github people wont show those not working in github for example designer.

@asirota
Copy link
Member Author

asirota commented Nov 5, 2024

@yosefeliezrie can you try to make this happen? it's a good idea... It all bubbles up to their website - https://www.a11yproject.com/team/ - the JSON feeds this -- it's all a stack they are using -- @kylek14 @mattleach89

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants