Skip to content

Commit

Permalink
Made necessary changes
Browse files Browse the repository at this point in the history
  • Loading branch information
sank8-2 committed Oct 21, 2024
1 parent 849c662 commit dd74aa8
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 9 deletions.
6 changes: 3 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Naomi's user configuration files have moved from ~/.naomi to ~/.config/naomi to

#### Plugin settings

The populate.py script has been replaced with settings that exist within the individual plugins. This way, a plugin author needs information from the user to get the plugin working, this information can be encoded within the plugin and not have to be added to a file in the Naomi core.
The populate.py script has been replaced with settings that exist within the individual plugins. This way if a plugin author needs information from the user to get the plugin working, this information can be encoded within the plugin and not have to be added to a file in the Naomi core.
Settings have the following structure:

```py
Expand All @@ -84,11 +84,11 @@ Plugins are listed within profile.yml and can be enabled or disabled by setting

#### Passive Listen

Naomi can be set to collect audio, and if audio contains the wakeword, use the active listener to scan the captured audio, allowing a more natural conversation style. Requires setting the "passive_listen: true" value in profile.yml or running Naomi with the --passive-listen flag.
Naomi can be set to collect audio and then if audio contains the wakeword, use the active listener to scan the captured audio, allowing a more natural conversation style. Requires setting the "passive_listen: true" value in profile.yml or running Naomi with the --passive-listen flag.

#### Asynchronous Say

Talking can happen in a separate thread so Naomi can listen while talking, allowing the user to stop Naomi in the middle of a response by saying "Naomi Stop". Unfortunately, with most audio setups, this causes Naomi to react to its own voice, so this is disabled by default while working out how to filter out the sound of Naomi speaking. Currently best used with either headphones or a USB conference phone with hardware level feedback filtering. Activated by either passing the "--listen-while-talking" flag or setting "listen_while_talking: true" in profile.yml.
Talking can happen in a separate thread so Naomi can listen while talking, allowing the user to stop Naomi in the middle of a response by saying "Naomi Stop". Unfortunately, with most audio setups this causes Naomi to react to its own voice, so this is disabled by default while working out how to filter out the sound of Naomi speaking. Currently best used with either headphones or a USB conference phone with hardware level feedback filtering. Activated by either passing the "--listen-while-talking" flag or setting "listen_while_talking: true" in profile.yml.

#### Syncronous Mic

Expand Down
11 changes: 6 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Want to contribute to Naomi ? Great ! 🎉 We're always happy to have more contributors. Before you start developing, though, we ask that you read through this document in-full. It's full of tips and guidelines--if you skip it, you'll likely miss something important (and your pull request will probably be rejected as a result).

Throughout the process of contributing, there's one thing we'd like you to remember: Naomi is developed (and is maintained) by what might be described as "volunteers." They earn no money for their work here and give their time solely for the advancement of the software and the enjoyment of its users. While they will do their best to get back to you regarding issues and pull requests, your patience is appreciated.
Throughout the process of contributing, there's one thing we'd like you to remember: Naomi is developed (and is maintained) by what might be described as "volunteers". They earn no money for their work here and give their time solely for the advancement of the software and the enjoyment of its users. While they will do their best to get back to you regarding issues and pull requests, your patience is appreciated.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

Expand All @@ -16,13 +16,14 @@ As of time of writing, we are open to any ideas or contributions anyone may have

## Responsibilities

* Ensure code compatibility for every change. We do not want to break everything just for one feature. If in testing your contribution causes issues but in its self works as intended, try to fix the issues that have arisen. At the end of the day, we are all working towards a better Naomi.
* Ensure code compatibility for every change. We No-Code Leaderboard
do not want to break everything just for one feature. If in testing your contribution causes issues but in its self works as intended, try to fix the issues that have arisen. At the end of the day, we are all working towards a better Naomi.
* Ensure that code that goes into Naomi meets all requirements.
* Create issues for any changes and enhancements that you wish to make. Discuss things transparently and get community feedback.

# Your First Contribution

Due to the nature of the project and at the time of writing, you can look through [issues](https://www.github.com/naomiproject/naomi/issues) and if there is something that you can aid in, jump right to it. Some things might be simple bug fixes that may take only a few lines of code, while others may take editing multiple documents and structures already assembled. Those required someone that understands Naomi from front to back and has worked on the project for some time. In other words, do not bite off more than you can chew, every little step helps.
Due to the nature of the project and at the time of writing, you can look through [issues](https://www.github.com/naomiproject/naomi/issues) and if there is something that you can aid in, jump right to it. Some things might be simple bug fixes that may take only a few lines of code, while others may take editing multiple documents and structures already assembled. Those required someone that understands Naomi front to back and has worked on the project for some time. In other words, do not bite off more than you can chew, every little step helps.

## Resource for people who have never contributed to open source before.

Expand All @@ -45,7 +46,7 @@ However, if a maintainer asks you to "rebase" your pull request, they're saying
* Once the PR has been submitted, a bot will ask you to sign a Contribution License Agreement, CLA. (All contributors to the PR have to accept the CLA in order for the PR to be accepted.)
* The maintainer will review your submission and either ask for clarifications or changes, or approve the PR and it will be merged.

# Labelling conventions for issues & pull requests
# Labeling conventions for issues & pull requests

Our issues and pull requests follow a [labelling convention](https://github.com/NaomiProject/Naomi/issues/126) to aid with flow & organization. Please review them so you know what each label means and how they are used.

Expand All @@ -70,7 +71,7 @@ If you have found a bug, please create an issue using the bug report template an
## How to suggest a feature or enhancement

If you have an idea that you think will improve upon Naomi, create an issue using the proper template and fill it out to the best of your ability. Once submitted, the community will discuss with you the idea to help flesh it out and give it a base to be built upon. This will allow us to determine whether or not the idea should be implemented, put on hold due to other issues or pull requests that are currently open at that time, or abandoned if it does not fit into the scope of Naomi. Once approved, the idea can either be worked on by either the submitter if they so choose or made available for other developers and maintainers to turn the idea into reality.
If you have an idea that you think will improve upon Naomi, create an issue using the proper template and fill it out to the best of your ability. Once submitted, the community will discuss the idea with you to help flesh it out and give it a base to be built upon. This will allow us to determine whether or not the idea should be implemented, put on hold due to other issues or pull requests that are currently open at that time, or abandoned if it does not fit into the scope of Naomi. Once approved, the idea can either be worked on by either the submitter if they so choose or made available for other developers and maintainers to turn the idea into reality.

If you find yourself wishing for a feature that doesn't exist in Naomi, you are probably not alone. There are bound to be others out there with similar needs. Many of the features that Naomi has today have been added because users saw the need. Open an issue on our issues list on GitHub that describes the feature you would like to see, why you need it, and how it should work.

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Naomi is an MIT-licensed open source project with its ongoing development made p

## Credits

This software uses code from the initial Jasper Project & the Jasper2Fork.
This software uses code from the initial Jasper Project & the Jasper2fork.

* [JasperProject](http://jasperproject.github.io/)
* [Jasper2Fork](https://github.com/andweber/j2f)
Expand Down

0 comments on commit dd74aa8

Please sign in to comment.