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

Update contributing possibilities #888

Open
lappemic opened this issue Oct 18, 2024 · 4 comments
Open

Update contributing possibilities #888

lappemic opened this issue Oct 18, 2024 · 4 comments

Comments

@lappemic
Copy link
Contributor

At the moment the contributing guidlines mention only how to add a project or join the community, but not e.g. how to contribute to the website itself. I think it would be nice to encourage people to contribute to the website itself as well if they see potential of improvements, correct typos, or other issues.

Suggested changes

  • Update Contributing.md to include encouragment and instructions on how to make changes for the website
  • Update the codebase to facilitate changes on the website for new contributers (e.g. add a requirements file, update .gitignore with virtualenvs, etc.)

If this is something you also think is worth doing, let me know. I would make the needed changes with pleasure.

@Ly0n
Copy link
Member

Ly0n commented Oct 18, 2024

Thank you very much @lappemic for this suggestion. What you say is definitely valid and should be implemented as you have already suggested. We should also do some small documentation about the integration of ecosyste.ms and how the grist document is updated via GitHub Action. For someone newcomer to the project, this could be very confusing to understand without some smaller documentation. A flowchart could help a lot here. I can create this!

@lappemic
Copy link
Contributor Author

Is there already something documented about the ecosyste.ms and grist integration?

Will make a draft pr next week for this 👍

@Ly0n
Copy link
Member

Ly0n commented Oct 18, 2024

Only the backend repo provides some information, but how they are connected is not yet documented.
https://github.com/ecosyste-ms/ost
https://ost.ecosyste.ms/docs/index.html

A flowchart showing all the relevant scripts, files and APIs is definitely missing.

@Ly0n
Copy link
Member

Ly0n commented Oct 28, 2024

I created a flow chart for the OST repo showing the main workflow: https://drive.google.com/file/d/1-bZ57M3uMi2_aPSZU1NvK1hHKQbzLU1J/view

Just click "Open with" --> "Draw.io" and you should be able to add edit this file.

The integration of ecosystem.ms and ClimateTriage.com needs more detail.
Is this helpful? @lappemic

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