Skip to content

Remove outdated guidance for developers #2563

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

Merged
merged 6 commits into from
Apr 29, 2021
Merged

Remove outdated guidance for developers #2563

merged 6 commits into from
Apr 29, 2021

Conversation

ttuegel
Copy link
Contributor

@ttuegel ttuegel commented Apr 20, 2021

This pull request updates the guidance for developers in README.md and changes the shell.nix environment to match.


Review checklist

The author performs the actions on the checklist. The reviewer evaluates the work and checks the boxes as they are completed.

  • Summary. Write a summary of the changes. Explain what you did to fix the issue, and why you did it. Present the changes in a logical order. Instead of writing a summary in the pull request, you may push a clean Git history.
  • Documentation. Write documentation for new functions. Update documentation for functions that changed, or complete documentation where it is missing.
  • Tests. Write unit tests for every change. Write the unit tests that were missing before the changes. Include any examples from the reported issue as integration tests.
  • Clean up. The changes are already clean. Clean up anything near the changes that you noticed while working. This does not mean only spatially near the changes, but logically near: any code that interacts with the changes!

@ttuegel ttuegel requested a review from andreiburdusa April 20, 2021 16:30
Copy link
Contributor

@andreiburdusa andreiburdusa left a comment

Choose a reason for hiding this comment

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

Beside what Virgil already noticed, the pr looks good

@rv-jenkins rv-jenkins merged commit 314b81b into master Apr 29, 2021
@rv-jenkins rv-jenkins deleted the nix-shell branch April 29, 2021 17:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants