mirror of
https://github.com/nerfstudio-project/nerfstudio.git
synced 2026-11-21 23:25:39 +08:00
Rename repo to nerfactory (#204)
* Rename to nerfactory * Fix missing files
This commit is contained in:
1 parent
8db05d8299
commit
6dc704c551
187 files changed
+259775
-259761
No files matched your search
@@ -1,21 +1,21 @@
|
||||
# Contributing to pyRad workflow
|
||||
# Contributing to nerfactory workflow
|
||||
|
||||
The project is set up for development in VSCode, we reccomend using it if you plan to contribute.
|
||||
|
||||
## TLDR
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| linter | Black |
|
||||
| Testing | PyTest |
|
||||
| Docs | Sphinx |
|
||||
| | |
|
||||
| --------------- | ------ |
|
||||
| linter | Black |
|
||||
| Testing | PyTest |
|
||||
| Docs | Sphinx |
|
||||
| Docstring style | Google |
|
||||
|
||||
## Commiting
|
||||
|
||||
1. Make your modifications
|
||||
2. Perform local checks
|
||||
|
||||
|
||||
To ensure that you will be passing all tests and checks on github, you will need to run the following command:
|
||||
|
||||
```bash
|
||||
@@ -23,12 +23,13 @@ The project is set up for development in VSCode, we reccomend using it if you pl
|
||||
```
|
||||
|
||||
This will perform the following checks and actions:
|
||||
- Black/ Linting style check: Ensure that the code is consistently and properly formatted.
|
||||
|
||||
- Black/ Linting style check: Ensure that the code is consistently and properly formatted.
|
||||
- Pytests: Runs pytests locally to make sure the logic of any added code does not break existing logic.
|
||||
- Documentation build: Builds the documentation locally to make sure none of the changes result in any warnings or errors in the docs.
|
||||
- Licensing: automatically adds licensing headers to the correct files.
|
||||
|
||||
In order to merge changes to the code base, all of these checks must be passing. If you pass these tests locally, you will likely pass on github servers as well (results in a green checkmark next to your commit).
|
||||
|
||||
In order to merge changes to the code base, all of these checks must be passing. If you pass these tests locally, you will likely pass on github servers as well (results in a green checkmark next to your commit).
|
||||
|
||||
3. Open pull request
|
||||
|
||||
|
||||
Reference in new issue
Block a user