Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for library organization best practices #513

Merged
merged 1 commit into from
Apr 19, 2022

Conversation

nre-ableton
Copy link
Contributor

I'm improving the documentation in the README to add some best-practices regarding library organization. This is based mostly on a recent discussion in another issue, but also because I find myself copy-pasting the same advice to several other issues.

  • Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
  • Ensure that the pull request title represents the desired changelog entry
  • Please describe what you did
  • Link to relevant issues in GitHub or Jira
  • Link to relevant pull requests, esp. upstream and downstream changes
  • Ensure you have provided tests - that demonstrates feature works or fixes the issue

@nre-ableton nre-ableton requested a review from stchar April 12, 2022 17:03
@nre-ableton
Copy link
Contributor Author

Since I'm pretty much the only active maintainer of this repo these days, I'll merge this PR in one week unless there are any objections. Reviews would be appreciated, though.

Copy link
Contributor

@UlrichEckhardt UlrichEckhardt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like a good step forward!

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@nre-ableton nre-ableton force-pushed the nre/master/add-organization-docs branch from 105d0ea to c50e27e Compare April 13, 2022 08:45

@Test
void testComplexOperation() {
int result = new HardMath(script: script).complexOperation(1, 3)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

new HardMath(..) is awesome. I used to create pipeline script just as EmptyPipeline but to load the library and to return an instance of my library class. But your approach is way way way better.

Copy link
Contributor

@stchar stchar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to me

@nre-ableton nre-ableton merged commit 1caecc4 into master Apr 19, 2022
@nre-ableton nre-ableton deleted the nre/master/add-organization-docs branch April 19, 2022 08:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants