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

Centralize project contributor and author recognitions #104

Closed
oxcabe opened this issue Mar 15, 2024 · 16 comments · Fixed by #113
Closed

Centralize project contributor and author recognitions #104

oxcabe opened this issue Mar 15, 2024 · 16 comments · Fixed by #113

Comments

@oxcabe
Copy link
Member

oxcabe commented Mar 15, 2024

Description

Author recognition is spread throughout the entire project. Some examples are:

SIMDE/docs/en/autor.md

Lines 1 to 19 in e3fa8e6

---
layout: default
lang: en
id: autor
title: Contact with the autor
prev: en/referencias.html
next: en/bloques-basicos.html
---
The original version of this documentation and the application it references have been made by Iván Castilla Rodríguez.
The new version of this application and this documentation have
been made by Adrián Abreu González.
If you have any suggestion about this application, please contact us
at:
[[email protected]]([email protected])
[[email protected]]([email protected])

and

return (<Modal show={this.props.isAuthorModalOpen} onHide={this.close}>
<Modal.Header closeButton>
<Modal.Title>{this.props.t('authorModal.title')}</Modal.Title>
</Modal.Header>
<Modal.Body>
<div className='text-center'>
<div className='row'>
<div className='col-sm-12'>
<label>{this.props.t('authorModal.originalAuthor')}</label>: Iván Castilla Rodríguez
</div>
</div>
<div className='row'>
<div className='col-sm-12'>
<label>{this.props.t('authorModal.newAuthor')}</label>: Adrián Abreu González
</div>
</div>
</div>
</Modal.Body>
<Modal.Footer>
<Button onClick={this.close}>{this.props.t('commonButtons.close')}</Button>
</Modal.Footer>
</Modal>);

Proposed solution

  • Use a general recognition name (e.g. "The SIMDE authors") for smaller inputs, such as the "author" field in package.json.
  • Add a general "Contributors" section in the README.md, managed and maintained through Recognize All Contributors.
  • Add an "About" section in the front-end, listing front-end contributors.
  • Add an "Acknowledgements" section in the documentation, listing documentation contributors.
  • Add the list of contributors to each release message and CHANGELOG section.
  • Finally, update them accordingly when new releases are created.
@endes0
Copy link
Member

endes0 commented Mar 15, 2024

I suggest also to add a "Citation" section like Ripes as the root of this project is academic.

@oxcabe
Copy link
Member Author

oxcabe commented Mar 15, 2024

Sounds good to me.

@endes0
Copy link
Member

endes0 commented Mar 15, 2024

@all-contributors please add @icasrod for creating the original simulator + BDFL. please add @adrianabreu for creating the web version. please add @alu0100884012 for Melissa: implementing the VLIW machine. please add @oxcabe for maintaining the project. please add @endes0 for maintaining the project.

@endes0
Copy link
Member

endes0 commented Mar 15, 2024

https://github.com/all-contributors please add @icasrod for creating the original simulator + BDFL. please add @adrianabreu for creating the web version. please add @alu0100884012 for Melissa: implementing the VLIW machine. please add @oxcabe for maintaining the project. please add @endes0 for maintaining the project.

@oxcabe
Copy link
Member Author

oxcabe commented Mar 15, 2024

@all-contributors
please add @icasrod for creating the original simulator + BDFL.
please add @adrianabreu for creating the web version.
please add @alu0100884012 for Melissa: implementing the VLIW machine.
please add @oxcabe for maintaining the project. please add @endes0 for maintaining the project.

Copy link
Contributor

@endes0

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

I've put up a pull request to add @oxcabe! 🎉

I've put up a pull request to add @endes0! 🎉

Copy link
Contributor

@oxcabe

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

@oxcabe already contributed before to maintenance, projectManagement

@endes0 already contributed before to maintenance, projectManagement

@endes0
Copy link
Member

endes0 commented Mar 15, 2024

@all-contributors
please add @icasrod for 🔬📆🧑‍🏫🤔💡📖.
please add @adrianabreu for 📦🎨.
please add @alu0100884012 aka Melissa for 📦 .
please add @oxcabe for 🧑‍🏫🚧🚇.
please add @endes0 for ⚠️🚧.

Copy link
Contributor

@endes0

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

@endes0
Copy link
Member

endes0 commented Mar 15, 2024

@all-contributors
please add @icasrod for research, projectManagement, mentoring, ideas, example, doc.
please add @adrianabreu for platform, design.
please add @alu0100884012 for platform.
please add @oxcabe for mentoring, maintenance, platform.
please add @endes0 for test, maintenance.

Sorry to all people mentioned for the spam, the bot is giving us a fight!

@endes0
Copy link
Member

endes0 commented Mar 15, 2024

I give up (verilog pun intended)

@oxcabe
Copy link
Member Author

oxcabe commented Mar 15, 2024

Is it refreshing after each new comment?

Copy link
Contributor

@endes0

I've put up a pull request to add @icasrod! 🎉

I've put up a pull request to add @adrianabreu! 🎉

We had trouble processing your request. Please try again later.

@oxcabe
Copy link
Member Author

oxcabe commented Mar 15, 2024

@all-contributors
please add @alu0100884012 for platform.
please add @oxcabe for mentoring, maintenance, platform.
please add @endes0 for test, maintenance.

@oxcabe
Copy link
Member Author

oxcabe commented Mar 15, 2024

@all-contributors please add @endes0 for test, maintenance.

Copy link
Contributor

@oxcabe

I've put up a pull request to add @endes0! 🎉

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

Successfully merging a pull request may close this issue.

2 participants