-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improved layout of files for open source release
The directories and files are mostly organized now according to de facto standard for organizing code. This work is completed partially for #140 Please note: this is not a functional commit. It in no way is buildable.
- Loading branch information
Showing
1,107 changed files
with
93 additions
and
2,148 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
Contributing to audio-analysis | ||
========================= | ||
|
||
Help wanted | ||
------------ | ||
|
||
We mark the most straightforward issues as "help wanted". This set of issues is the place to start if you are interested in contributing but new to the codebase. | ||
|
||
- [QutEcoacoustics/audio-analysis - "up for grabs"](https://github.com/QutEcoacoustics/audio-analysis/labels/up%20for%20grabs) | ||
|
||
|
||
Contribution "Bar" | ||
------------------ | ||
|
||
Project maintainers will merge changes that improve the product significantly and broadly and that align with our roadmap. | ||
|
||
Contributions must also satisfy the other published guidelines defined in this document. | ||
|
||
DOs and DON'Ts | ||
-------------- | ||
|
||
Please do: | ||
|
||
* **DO** follow our (enforce by StyleCop) | ||
* **DO** give priority to the current style of the project or file you're changing even if it diverges from the general guidelines. | ||
* **DO** include tests when adding new features. When fixing bugs, start with | ||
adding a test that highlights how the current behavior is broken. | ||
* **DO** keep the discussions focused. When a new or related topic comes up | ||
it's often better to create new issue than to side track the discussion. | ||
* **DO** blog and tweet (or whatever) about your contributions, frequently! | ||
|
||
Please do not: | ||
|
||
* **DON'T** make PRs for style changes. | ||
* **DON'T** surprise us with big pull requests. Instead, file an issue and start | ||
a discussion so we can agree on a direction before you invest a large amount | ||
of time. | ||
* **DON'T** commit code that you didn't write. If you find code that you think is a good fit, file an issue and start a discussion before proceeding. | ||
* **DON'T** submit PRs that alter licensing related files or headers. | ||
|
||
Commit Messages | ||
--------------- | ||
|
||
Please format commit messages as follows (based on [A Note About Git Commit Messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)): | ||
|
||
``` | ||
Summarize change in 50 characters or less | ||
Provide more detail after the first line. Leave one blank line below the | ||
summary and wrap all lines at 72 characters or less. | ||
If the change fixes an issue, leave another blank line after the final | ||
paragraph and indicate which issue is fixed in the specific format | ||
below. | ||
Fix #42 | ||
``` | ||
|
||
Also do your best to factor commits appropriately, not too large with unrelated things in the same commit, and not too small with the same small change applied N times in N different commits. | ||
|
||
File Headers | ||
------------ | ||
|
||
StyleCop automatically suggest an appropriate file header. Please use it at the top of all new files. | ||
|
||
|
||
Copying Files from Other Projects | ||
--------------------------------- | ||
|
||
We sometimes use files from other projects, typically where a binary distribution does not exist or would be inconvenient. | ||
|
||
The following rules must be followed for PRs that include files from another project: | ||
|
||
- The license of the file is [permissive](https://en.wikipedia.org/wiki/Permissive_free_software_licence). | ||
- The license of the file is left in-tact. | ||
|
||
Porting Files from Other Projects | ||
--------------------------------- | ||
|
||
There are many good algorithms implemented in other languages that would benefit the .NET Core project. | ||
The rules for porting an R file to C#, for example, are the same as would be used for copying the same file, as described above. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -30,7 +30,8 @@ $RECYCLE.BIN/ | |
[Dd]ebugPublic/ | ||
[Rr]elease/ | ||
x64/ | ||
build/ | ||
artefacts/ | ||
artifacts/ | ||
bld/ | ||
[Bb]in/ | ||
[Oo]bj/ | ||
|
19 changes: 0 additions & 19 deletions
19
Acoustics/Acoustics.Shared/Acoustics.Shared.ncrunchproject
This file was deleted.
Oops, something went wrong.
29 changes: 0 additions & 29 deletions
29
Acoustics/Acoustics.Shared/Acoustics.Shared.v2.ncrunchproject
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
19 changes: 0 additions & 19 deletions
19
Acoustics/Acoustics.Tools/Acoustics.Tools.v2.ncrunchproject
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.