Conda-forge.github.io: Communicating New Recipe Policies/Best Practices

Created on 2 May 2018  路  13Comments  路  Source: conda-forge/conda-forge.github.io

@jakirkham suggested that I start a new issue here to discuss ways of communicating new recipe policies and best practices, as well as conda behavior changes. If you're not following every issue on a number of repos, it's hard to tell what changes are in the pipeline or under discussion.

The only idea that I had was some sort of low volume email list or newsletter that highlights when a change is made to the documentation that reviewers should know about, or if a major change is under discussion that will effect how recipes are written. I imagine the list/newsletter would mostly be subscribed to by staged-recipe reviewers.

Thoughts?

Discussion

Most helpful comment

A best practice update would also be nice for maintainers to know if packages need to be updated or if I can start to use new compiler options in builds (conda-build 3).

This would also be good to communicate larger general changes that happen with conda-forge packages.

A list/newsletter/blog (RSS) style option would definitely be nice.

All 13 comments

A best practice update would also be nice for maintainers to know if packages need to be updated or if I can start to use new compiler options in builds (conda-build 3).

This would also be good to communicate larger general changes that happen with conda-forge packages.

A list/newsletter/blog (RSS) style option would definitely be nice.

Thanks all. These are good ideas.

Hadn't thought about a newsletter for this, but agree that would be a good option. There is a mailing list, but it's been relative unstructured and not used for this intent. We could look at adding a thread in there for this purpose.

We have discussed a blog before (even in the past few weeks). Maybe we could have it dual for other purposes (e.g. have a feed, maybe IFTTT to send out an email). Good thinking.

Any thoughts on how we handle questions for announced changes (particularly given volume is a concern)? Thought on how we should do things for proposed changes?

cc @conda-forge/core

("Bioconda awareness ping": @conda-forge/bioconda-recipes)

The changes in the following PR would be a prime candidate for the sort of thing that should be highlighted and explained to both reviewers and package maintainers since it constitutes a fairly big change in the example recipe:

https://github.com/conda-forge/staged-recipes/pull/5802

  • Most recipes don't use the host section so an explanation is needed as to why this is needed
  • removal of the toolchain in place of a compiler templating line
  • etc

Whatever option is taken, I hope it's something that can be searched against and a complete history is available for new members to review when they join.

I recently had a question about building recipes for multiple versions of R. I searched all the documentation that I could find, but wasn't able to find an explanation. I ended up opening an issue, and my question was promptly answered. Apparently there was a decision to drop support for R 3.3.2, which I completely support. However, I haven't seen this decision communicated outside of the issues/PRs linked to within my question.

It would be great to have a place to read about these types of changes when they're made as well as to reference after the fact.

We've added a news page accessible from the website, which can serve this purpose.

ref: https://conda-forge.org/docs/news_announce.html

I'm adding an RSS feed from the news page: https://github.com/conda-forge/conda-forge.github.io/pull/1221

Thank you for doing that! 馃槃

Should we do this for the blog as well?

The blog has one already. I added a link to it in the documentation.

I think maybe this issue can be closed?

Interesting one uses Atom and the other RSS. Maybe we should use RSS for both (or Atom)?

Yeah let's close. We can follow up on other things in new issues.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

croth1 picture croth1  路  5Comments

prachi237 picture prachi237  路  4Comments

h-vetinari picture h-vetinari  路  4Comments

bulli92 picture bulli92  路  4Comments

prachi237 picture prachi237  路  5Comments