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

DOC: Add instruction to make a new branch from 'main' #29226

Merged

Conversation

matthewfeickert
Copy link
Member

  • Multiple people forget to do this when trying to add recipes and then run into trouble, so add an explicit instruction to create a new branch.

Checklist

  • Title of this PR is meaningful: e.g. "Adding my_nifty_package", not "updated meta.yaml".
  • [N/A] License file is packaged (see here for an example).
  • [N/A] Source is from official source.
  • [N/A] Package does not vendor other packages. (If a package uses the source of another package, they should be separate packages or the licenses of all packages need to be packaged).
  • [N/A] If static libraries are linked in, the license of the static library is packaged.
  • [N/A] Package does not ship static libraries. If static libraries are needed, follow CFEP-18.
  • [N/A] Build number is 0.
  • [N/A] A tarball (url) rather than a repo (e.g. git_url) is used in your recipe (see here for more details).
  • [N/A] GitHub users listed in the maintainer section have posted a comment confirming they are willing to be listed there.
  • [N/A] When in trouble, please check our knowledge base documentation before pinging a team.

* Multiple people forget to do this when trying to add recipes and then run
  into trouble, so add an explicit instruction to create a new branch.
@matthewfeickert
Copy link
Member Author

@conda-forge/staged-recipes, ready for review!

@matthewfeickert matthewfeickert marked this pull request as ready for review February 21, 2025 00:07
Copy link
Contributor

To help direct your pull request to the best reviewers, please mention a topic-specifc team if your recipe matches any of the following: conda-forge/help-c-cpp, conda-forge/help-cdts, conda-forge/help-go, conda-forge/help-java, conda-forge/help-julia, conda-forge/help-nodejs, conda-forge/help-perl, conda-forge/help-python, conda-forge/help-python-c, conda-forge/help-r, conda-forge/help-ruby,or conda-forge/help-rust. Thanks!

@matthewfeickert matthewfeickert changed the title DOC: Add instruction to make a new branch from 'main' [ci skip] DOC: Add instruction to make a new branch from 'main' Feb 21, 2025
Copy link
Member

@mfansler mfansler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a good recommendation. However, I'll defer to others for merging.

Also, worth noting that this simply brings the README here into harmony with the documentation: https://conda-forge.org/docs/maintainer/adding_pkgs/#step-by-step-instructions

@matthewfeickert
Copy link
Member Author

Also, worth noting that this simply brings the README here into harmony with the documentation: https://conda-forge.org/docs/maintainer/adding_pkgs/#step-by-step-instructions

That alone is worth it. (Some) people realistically aren't reading the maintainer docs before coming here, but if that's the goal then it should be made much more prominent than a link in step 2 of high level instructions in the README

2. Make a new folder in `recipes` for your package. Look at the [example recipe](recipes/example), our [documentation](http://conda-forge.org/docs/maintainer/adding_pkgs.html#) and the [FAQ](https://github.com/conda-forge/staged-recipes#faq) for help.

@ocefpaf
Copy link
Member

ocefpaf commented Feb 21, 2025

The linter is probably stuck b/c it is looking for a recipe. Merging this... Thanks!

@ocefpaf ocefpaf merged commit de433fd into conda-forge:main Feb 21, 2025
@matthewfeickert matthewfeickert deleted the docs/add-branch-to-instructions branch February 21, 2025 18:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

3 participants