search

Green-Software-Foundation / learn

Green Software Practitioner course
https://learn.greensoftware.foundation/
Other
68 stars 27 forks source link

Update Contributing information (and suggestions) #174

Closed renao closed 10 months ago

renao commented 1 year ago

Hello everyone,

I just saw that dead link inside the CONTRIBUTING file and fixed it.

There are still two things one could improve but I don't know if it is how you'd like to have it, so I didn't commit changes for that by now:

  1. For me the Green Software Foundation is very new and I didn't know what the WG would be. Perhaps it would be much clearer to replace unexplained acronyms by using their full names (or perhaps link to a explanation?)
  2. As far as I found out there is no dev branch that should be the target for the pull requests - should it be the main branch instead?

Yes, it is a file one does not recognize if you are already working in these projects - but perhaps we could lower the bar to contribute by making things a bit clearer :)

Here's an example how it could look like:

# Contributing

1. Create a [new issue](https://github.com/Green-Software-Foundation/learn/issues/new)
2. Discuss your issue with the Community Working Group and [create a pull request](https://github.com/Green-Software-Foundation/learn/compare) if required
3. The pull request has to be submitted against the **main** branch
4. the pull request will be discussed with the Community Working Group. If agreed, the Working Groups Chair will merge into **main**
russelltrow commented 10 months ago

Thank you @renao, I've merged your PR and taken onboard your recommendations and updated the content.