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

Improve advice on contributing patches #1856

Merged
merged 2 commits into from Jul 14, 2017

Conversation

gassmoeller
Copy link
Member

After reading through most of https://opensource.guide/ I made some more changes to our readme and contributing.md. Hopefully this will lower the barrier to contribute to ASPECT. One thing I am not sure about is the advice on including a code of conduct in the repository. I am not aware that we had much trouble in this regard so far, and I dislike playing by github's rules, just to get our last checkmark at https://github.com/geodynamics/aspect/community, but on the other hand it is not much of a pain, and might become useful. What do others think?

Please wait with merging this PR, I am currently waiting for a response from UC Davis IT staff as to how to search through our mailing list (if that is at all possible).

@bangerth
Copy link
Contributor

I made a couple of text updates via the web interface, but the rest looks good. Thanks for working on this!

@bangerth bangerth merged commit 79bf5b1 into geodynamics:master Jul 14, 2017
@bangerth
Copy link
Contributor

Oh, and now I see your last sentence :-( My apologies for being too quick :-(

As for a CoC: That's a good question. Neither the deal.II nor the ASPECT communities have had problems with uncivil behavior in the last few years. Thus, I have no idea whether a CoC would actually make a difference in actual practice. But then I'm not an expert on these things either and sometimes good things happen that you don't foresee. What do others think?

@naliboff
Copy link
Contributor

@gassmoeller - I just spoke with @tjesser-ucdavis-edu and unfortunately there is no way straightforward to easily search through the mailing list. Perhaps other platforms offer this feature? It certainly would be nice.

CoC: It's hard to imagine uncivil discourse amongst this user group and what such discourse would look like. Perhaps a CoC is not necessary until we actually find an incident to base it on?

@gassmoeller
Copy link
Member Author

No harm done, I opened #1856 to remove the advice about the mailing list.
I am no expert on available systems for mailing lists, I just know of the deal.II mailings lists hosted on google groups (https://groups.google.com/forum/#!forum/dealii) that have (unsurprisingly) a nice search feature. @bangerth does that work out well for deal.II?

Concerning CoC: I am fine postponing the issue to a later point. Some projects mention they had wished to have a CoC before something happened, but I agree that in my view our community currently has no need for it ❤️.

If anyone feels differently, please let one of us know!

@gassmoeller gassmoeller deleted the improve_readme branch July 15, 2017 00:46
@ljhwang
Copy link
Contributor

ljhwang commented Jul 15, 2017 via email

@bangerth
Copy link
Contributor

Re mailing list: I think the google forum works great from a practical perspective, with only one (but serious!) drawback: it can't be accessed from China. I wished we had chosen a different solution. I do agree that it's a bit annoying to use a mailing list software that in 2017 doesn't support searching -- surely we can do better.

@gassmoeller
Copy link
Member Author

@ljhwang: http://contributor-covenant.org offers an easy to use code of conduct for open source projects that is used by many projects.
Its text is here:
http://contributor-covenant.org/version/1/4/

And regarding mailing list: That is of course a pitty. Maybe we need a different solution then.

@tjhei
Copy link
Member

tjhei commented Jul 15, 2017

Concerning CoC: I am fine postponing the issue to a later point.

agreed.

mailing list

It is a shame that access from China is blocked, otherwise google groups is great for several reasons:

  • everybody can decide if they want to use it as a forum or as a mailing list
  • voting, labeling, marking as "resolved" features
  • very good spam handling

@ljhwang
Copy link
Contributor

ljhwang commented Jul 15, 2017 via email

@bangerth
Copy link
Contributor

I'm no longer familiar with the mailing list tool landscape. I suppose that there must be something that supports searching (possibly via an interface to one of the search machines), but I couldn't name anything.

@gassmoeller
Copy link
Member Author

Disclaimer: I have no experience hosting mailing lists, so I probably do not know the difference of a good and bad tool.
I looked around a bit:

  • Mailman seems to be a relatively standard mailing list tool, written in python (including regular expression searching), https://www.gnu.org/software/mailman/
  • I was really impressed by Discourse (http://www.discourse.org/), they seem to be widely used by companies (like Github, Twitter, Docker), their software is open-source (they offer plans for support and hosting), and they have a nice demo site running here https://try.discourse.org/ . It seems possible to search conversations similar to github (e.g. by author, by subject, in the full text, by date, or combinations thereof)

@tjhei
Copy link
Member

tjhei commented Jul 16, 2017

I was really impressed by Discourse

I was going to suggest discourse too. Maybe this is something we can play with.

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

Successfully merging this pull request may close these issues.

None yet

5 participants