Skip to content

Commit

Permalink
Merge pull request #395 from NLeSC/code-quality-#377
Browse files Browse the repository at this point in the history
Migrate Code quality to Best Practices chapter
  • Loading branch information
egpbos authored Dec 4, 2024
2 parents 96a5007 + ef44595 commit 4a6847f
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 18 deletions.
Binary file added .DS_Store
Binary file not shown.
1 change: 0 additions & 1 deletion _sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
* [UX - User Experience](/technology/user_experience.md)
* [Datasets](/technology/datasets.md)
* [Best practices](/best_practices/overview.md)
* [Code Quality](/best_practices/code_quality.md)
* [Code Review](/best_practices/code_review.md)
* [Releases](/best_practices/releases.md)
* [Documentation](/best_practices/documentation.md)
Expand Down
17 changes: 0 additions & 17 deletions best_practices/code_quality.md

This file was deleted.

16 changes: 16 additions & 0 deletions best_practices/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,22 @@ More info: [The Turing Way chapter on Version Control](https://book.the-turing-w
Tests are important for two reasons: 1. confirming the expected workings of your code while developing for the first time and 2. making sure your features keep working when later on you or others modify the implementation.
[The Turing Way gives an overview of the many ways to test code](https://book.the-turing-way.org/reproducible-research/testing).

## Code Quality

Ways to improve code quality are described in the [Code quality](https://book.the-turing-way.org/reproducible-research/code-quality.html) chapter on the Turing Way.

Explore [online tools for software quality improvement](https://book.the-turing-way.org/reproducible-research/code-quality/code-quality-style.html#online-services-providing-software-quality-checks). Additionally, check our [language guides](/language_guides/languages_overview.md) for language-specific recommendations.
[RSQKit: Research Software Quality Kit](https://everse.software/RSQKit/) also has many useful guides including software quality. These guides are result of an international collaboration primarily focusing on research software quality.
### EditorConfig

The eScience Center provides a [shared config file](https://raw.githubusercontent.com/NLeSC/exemplum/master/.editorconfig) for IDEs and text editors. This file helps standardize coding styles across projects.

### Namespaces

If your programming language supports namespaces, use your organization or project-specific namespace.

**@ NLeSC**, the recommended namespace is **nl.esciencecenter**, or adapt it to a namespace that aligns with your project's context.

## Know your tools

In addition to the advice on the best practices above, knowing the
Expand Down

0 comments on commit 4a6847f

Please sign in to comment.