diff --git a/README.md b/README.md index 15f8dfa46..51a57d2a0 100644 --- a/README.md +++ b/README.md @@ -70,14 +70,14 @@ Nerfstudio initially launched as an opensource project by Berkeley students in [ We are committed to providing learning resources to help you understand the basics of (if you're just getting started), and keep up-to-date with (if you're a seasoned veteran) all things NeRF. As researchers, we know just how hard it is to get onboarded with this next-gen technology. So we're here to help with tutorials, documentation, and more! -Have feature requests? Want to add your brand-spankin'-new NeRF model? Have a new dataset? **We welcome any and all [contributions](https://docs.nerf.studio/en/latest/reference/contributing.html)!** Please do not hesitate to reach out to the nerfstudio team with any questions via [Discord](https://discord.gg/uMbNqcraFc). +Have feature requests? Want to add your brand-spankin'-new NeRF model? Have a new dataset? **We welcome [contributions](https://docs.nerf.studio/en/latest/reference/contributing.html)!** Please do not hesitate to reach out to the nerfstudio team with any questions via [Discord](https://discord.gg/uMbNqcraFc). We hope nerfstudio enables you to build faster :hammer: learn together :books: and contribute to our NeRF community :sparkling_heart:. # Quickstart The quickstart will help you get started with the default vanilla NeRF trained on the classic Blender Lego scene. -For more complex changes (e.g., running with your own data/setting up a new NeRF graph, please refer to our [references](#learn-more). +For more complex changes (e.g., running with your own data/setting up a new NeRF graph), please refer to our [references](#learn-more). ## 1. Installation: Setup the environment diff --git a/docs/index.md b/docs/index.md index e5be4cdce..abddd1f82 100644 --- a/docs/index.md +++ b/docs/index.md @@ -35,7 +35,7 @@ It's as simple as plug and play with nerfstudio! On top of our API, we are committed to providing learning resources to help you understand the basics of (if you're just getting started), and keep up-to-date with (if you're a seasoned veteran) all things NeRF. As researchers, we know just how hard it is to get onboarded with this next-gen technology. So we're here to help with tutorials, documentation, and more! -Finally, have feature requests? Want to add your brand-spankin'-new NeRF model? Have a new dataset? **We welcome any and all [contributions](reference/contributing)!** +Finally, have feature requests? Want to add your brand-spankin'-new NeRF model? Have a new dataset? **We welcome [contributions](reference/contributing)!** Please do not hesitate to reach out to the nerfstudio team with any questions via [Discord](https://discord.gg/uMbNqcraFc). We hope nerfstudio enables you to build faster 🔨 learn together 📚 and contribute to our NeRF community 💖. @@ -190,3 +190,13 @@ If you use this library or find the documentation useful for your research, plea + +## Maintainers + +| | Nerfstudio Discord | Affiliation | +| -------------------------------------------- | ------------------ | ------------------------------------ | +| [Justin Kerr](https://kerrj.github.io/) | justin.kerr | UC Berkeley | +| [Jonáš Kulhánek](https://jkulhanek.com/) | jkulhanek | Czech Technical University in Prague | +| [Matt Tancik](https://www.matthewtancik.com) | tancik | UC Berkeley | +| [Ethan Weber](https://ethanweber.me/) | ethanweber | UC Berkeley | +| [Brent Yi](https://github.com/brentyi) | brent | UC Berkeley | diff --git a/docs/reference/contributing.md b/docs/reference/contributing.md index 101cb873e..84db92093 100644 --- a/docs/reference/contributing.md +++ b/docs/reference/contributing.md @@ -2,9 +2,13 @@ **💝 We're excited to have you join the nerfstudio family 💝** -Below, we document the contribution pipeline and good-to-knows for when you're ready to submit a PR. If you have any questions at all, please don't hesitate to reach out to us on [Discord](https://discord.gg/uMbNqcraFc). We'd love to hear from you! +We welcome community contributions to Nerfstudio! Whether you want to fix bugs, improve the documentation, or introduce new features, we appreciate your input. -The project is set up for development in VSCode, we recommend using it if you plan to contribute. +Bug fixes and documentation improvements are highly valuable to us. If you come across any bugs or find areas where the documentation can be enhanced, please don't hesitate to submit a pull request (PR) with your proposed changes. We'll gladly review and integrate them into the project. + +For larger feature additions, we kindly request you to reach out to us on [Discord](https://discord.gg/uMbNqcraFc) in the `#contributing` channel and create an issue on GitHub. This will allow us to discuss the feature in more detail and ensure that it aligns with the goals and direction of the repository. We cannot guarantee that the feature will be added to Nerfstudio. + +In addition to code contributions, we also encourage contributors to add their own methods to our documentation. For more information on how to contribute new methods, please refer to the documentation [here](../developer_guides/new_methods.md). ## Overview @@ -12,10 +16,12 @@ Below are the various tooling features our team uses to maintain this codebase. | Tooling | Support | | --------------- | ---------------------------------------------------------- | -| Linter | [Black](https://black.readthedocs.io/en/stable/) | +| Formatting | [Black](https://black.readthedocs.io/en/stable/) | +| Linter | [Pylint](https://readthedocs.org/projects/pylint/) | | Testing | [PyTest](https://docs.pytest.org/en/7.1.x/) | | Docs | [Sphinx](https://www.sphinx-doc.org/en/master/) | | Docstring style | [Google](https://google.github.io/styleguide/pyguide.html) | +| JS Linting | [eslint](https://eslint.org/) | ## Requirements @@ -59,6 +65,12 @@ conda install -c conda-forge pandoc 3. Open pull request! 💌 +:::{admonition} Note +:class: info + +We will not review the pull request until it is passing all checks. +::: + ## Maintaining documentation ### Building