mirror of
https://github.com/invoke-ai/InvokeAI
synced 2024-08-30 20:32:17 +00:00
update na & development docs
This commit is contained in:
parent
7c3fb3c54a
commit
7dd20090c2
@ -11,7 +11,9 @@ For more information, please review our area specific documentation:
|
|||||||
* #### [Node Documentation](../INVOCATIONS.md)
|
* #### [Node Documentation](../INVOCATIONS.md)
|
||||||
* #### [Local Development](../LOCAL_DEVELOPMENT.md)
|
* #### [Local Development](../LOCAL_DEVELOPMENT.md)
|
||||||
|
|
||||||
If you don't feel ready to make a code contribution yet, no problem! You can also help out in other ways, such as [documentation](documentation.md) or [translation](translation.md).
|
**New Contributers:** Take a look at our [new contributors checklist](newContributorChecklist.md)
|
||||||
|
|
||||||
|
If you don't feel ready to make a code contribution yet, no problem! You can also help out in other ways, such as [documentation](documentation.md), [translation](translation.md) or helping support other users and triage issues as they're reported in GitHub.
|
||||||
|
|
||||||
There are two paths to making a development contribution:
|
There are two paths to making a development contribution:
|
||||||
|
|
||||||
@ -23,7 +25,7 @@ There are two paths to making a development contribution:
|
|||||||
|
|
||||||
## Best Practices:
|
## Best Practices:
|
||||||
* Keep your pull requests small. Smaller pull requests are more likely to be accepted and merged
|
* Keep your pull requests small. Smaller pull requests are more likely to be accepted and merged
|
||||||
* Comments! Commenting your code helps reviwers easily understand your contribution
|
* Comments! Commenting your code helps reviewers easily understand your contribution
|
||||||
* Use Python and Typescript’s typing systems, and consider using an editor with [LSP](https://microsoft.github.io/language-server-protocol/) support to streamline development
|
* Use Python and Typescript’s typing systems, and consider using an editor with [LSP](https://microsoft.github.io/language-server-protocol/) support to streamline development
|
||||||
* Make all communications public. This ensure knowledge is shared with the whole community
|
* Make all communications public. This ensure knowledge is shared with the whole community
|
||||||
|
|
||||||
|
@ -51,6 +51,14 @@ git push origin branch-name-here
|
|||||||
|
|
||||||
If you’d like to learn more about contributing to Open Source projects, here is a [Getting Started Guide](https://opensource.com/article/19/7/create-pull-request-github).
|
If you’d like to learn more about contributing to Open Source projects, here is a [Getting Started Guide](https://opensource.com/article/19/7/create-pull-request-github).
|
||||||
|
|
||||||
|
|
||||||
|
## Best Practices:
|
||||||
|
* Keep your pull requests small. Smaller pull requests are more likely to be accepted and merged
|
||||||
|
* Comments! Commenting your code helps reviewers easily understand your contribution
|
||||||
|
* Use Python and Typescript’s typing systems, and consider using an editor with [LSP](https://microsoft.github.io/language-server-protocol/) support to streamline development
|
||||||
|
* Make all communications public. This ensure knowledge is shared with the whole community
|
||||||
|
|
||||||
|
|
||||||
## **Where can I go for help?**
|
## **Where can I go for help?**
|
||||||
|
|
||||||
If you need help, you can ask questions in the [#dev-chat](https://discord.com/channels/1020123559063990373/1049495067846524939) channel of the Discord.
|
If you need help, you can ask questions in the [#dev-chat](https://discord.com/channels/1020123559063990373/1049495067846524939) channel of the Discord.
|
||||||
|
@ -157,9 +157,9 @@ nav:
|
|||||||
- How to Contribute: 'contributing/CONTRIBUTING.md'
|
- How to Contribute: 'contributing/CONTRIBUTING.md'
|
||||||
- Development:
|
- Development:
|
||||||
- Overview: 'contributing/contribution_guides/development.md'
|
- Overview: 'contributing/contribution_guides/development.md'
|
||||||
|
- New Contributors: 'contributing/contribution_guides/newContributorChecklist.md'
|
||||||
- InvokeAI Architecture: 'contributing/ARCHITECTURE.md'
|
- InvokeAI Architecture: 'contributing/ARCHITECTURE.md'
|
||||||
- Frontend Documentation: 'contributing/contribution_guides/contributingToFrontend.md'
|
- Frontend Documentation: 'contributing/contribution_guides/contributingToFrontend.md'
|
||||||
- New Contributors: 'contributing/contribution_guides/newContributorChecklist.md'
|
|
||||||
- Local Development: 'contributing/LOCAL_DEVELOPMENT.md'
|
- Local Development: 'contributing/LOCAL_DEVELOPMENT.md'
|
||||||
- Documentation: 'contributing/contribution_guides/documentation.md'
|
- Documentation: 'contributing/contribution_guides/documentation.md'
|
||||||
- Nodes: 'contributing/INVOCATIONS.md'
|
- Nodes: 'contributing/INVOCATIONS.md'
|
||||||
|
Loading…
Reference in New Issue
Block a user