tenacom / aaalib Goto Github PK
View Code? Open in Web Editor NEWNothing to see here. Seriously. Move on.
Home Page: https://tenacom.github.io/AaaLib/
License: MIT License
Nothing to see here. Seriously. Move on.
Home Page: https://tenacom.github.io/AaaLib/
License: MIT License
1.0.1-preview
NO - This is a new bug
Static pages in docs still have their default contents from DocFx template.
The following files should contain something that at least makes some sense:
docs/index.md
docs/apidoc/index.md
docs/articles/intro.md
The above-mentioned files still have their default contents.
Build and serve documentation:
dotnet cake docs.cake --target All
Then open a browser on localhost:8080
.
Configuration is not important for this issue.
Writing this was a sub-optimal experience. We need a template for documentation-related issues.
2.0.1-preview
If we want procedures like testing and coverage, once implemented and tested here, to be suitable for at least the majority of real-world projects, we need some "real" code to test.
For starters, there is no meaningful way to "arrange, act, assert" when testing parameterless methods that always returns the same constant. But it's more complex than this. We should be able to meaningfully test Coverlet exclusions, determine whether we need some sort of per-project testing customization vs. a one-size-fits-all default.runsettings
file, and the list grows longer with each hour I spend on this.
AaaLib should contain some real-world, or at least real-world-like, code.
It should also contain different kinds of projects:
Once we have projects of different kinds to work on, we will also be able to add e.g. integration tests as briefly suggested in #10.
Code can be brought in from tutorials found on the web, at least initially.
Also, with all due respect to the late Douglas Adams, the Aaa
class has to go. It was good as a first, minimal example to start building Cake scripts and GitHub workflows, but once we have "real" code, it has no place here any longer.
n/a
Of course the removal of the Aaa
class is a breaking change. I don't expect much customer impact, though, as AaaLib
was never meant to be actually used as a dependency.
No response
1.0.1-preview
We all know how important the Answer is.
As a matter of fact, the team here has already gone to great lengths to provide every user with the Answer: we can get it in binary form simply by calling Aaa.GetTheAnswer()
, or even as Italian text with Aaa.GetTheAnswerInItalian()
.
What's missing IMHO is a method to retrieve this essential piece of information in Spanish. Spanish has a lot more speakers than Italian, so a GetTheAnswerInSpanish
method would allow applications to support a much greater number of users.
Add to the Aaa
class a method (probably called GetTheAnswerInSpanish
) that returns the Answer in Spanish.
The implementation could be similar to GetTheAnswerInItalian
. Namely:
string
on older frameworks and a ReadOnlySpan<char>
on frameworks with span support.Given this code:
Console.WriteLine(Aaa.GetTheAnswerInSpanish());
the console output should be:
Cuarenta y dos
I don't see any risks potentially arising from this improvement, as existing code would not be modified and the new methods, if correctly implemented, shouldn't present any particular security risk.
I have nothing else to say, but hey, this form won't test itself, right?
1.0.60
The decision had already been taken in Tenacom that C# 11 features are well worth the switch to a non-LTS SDK at a company level. .NET 7 became generally available yesterday, so it's time to take action.
While updating PolyKit and L.o.U.I.S. to the new SDK, I noticed that Microsoft extension libraries have already ditched the netcoreapp3.1
TFM, about one month in advance of EOL. IMHO this may well be considered a death certificate for .NET Core 3.1.
AaaLib should adopt the new SDK as soon as possible.
.NET 7 should also be added as a target framework and .NET Core 3.1 removed: not because of a technical necessity, but to keep in sync with PolyKit's "optimal TFM list" which is a good starting point for new library projects.
This should be just a matter of updating the SDK version in global.json
and changing the project's TargetFrameworks
.
n/a
The removal of the netcoreapp3.1
TFM is a breaking change.
No response
1.0.60
NO - This bug also affected the previous version
There are no tests in this repository.
Also, quite obviously, no coverage reports.
PR checks should include running tests.
The release workflow should, too.
dotnet test
is executed in the above-mentioned workflows, but it does nothing, as there are no tests.
(I'm getting boring, I know.)
n/a
n/a
AaaLib being an incubator for Tenacom's procedures and internal standards, it's not only a matter of writing tests. Which unit testing library do we use? Do we also use some helper library, e.g. FluentAssertions? Etc.
It's important to have a standard, so people can "jump" between projects and feel at home.
2.0.1-preview
See #17
Add a console executable project (AaaConsole
?) that uses AaaLib
and as many Microsoft extensions as possible: logging, hosting, command line...
No functional specs here: keep it simple, but try to integrate as many extensions as possible so it may become a usage example.
Use your imagination
n/a
n/a
No response
2.0.1-preview
See #17
A possible addition could be a simple Calculator class with methods like Add, Subtract, etc.
Viable places to look at for additions may be articles about unit testing, C# tutorials, etc.
Just some quick guidelines:
n/a (depends upon the actual additions)
As already pointed out in #17, the removal of class Aaa
is a breaking change, but no one is going to complain about it.
@ric15ni I'm fine with the same PR closing this issue and #10 together.
2.0.1-preview
See #17
Add a source generator with complete integration tests.
It should be an incremental generator (of course!) and use as many features as possible: MSBuild properties, MSBuild items, attributes...
The generated code should be well-behaved of course.
Integration tests should consist of simple example projects using the generator, plus test projects that have to build and execute successfully the example projects using MSBuild APIs.
n/a
n/a
No response
2.0.15-preview
NO - This bug also affected the previous version
When a test project is multi-target, VSTest generates multiple subdirectories under TestResults
, each with its own coverage report.
The result of merging all coverage reports is uploaded to Codecov.
Coverage reports are not merged and only one of them is uploaded to Codecov.
Run either build-test-pack
or release
workflow when a test project is multi-target. Verify that, if there is some code that only runs for one of the targets, coverage never reaches 100%, even though the test project actually covers 100% of the library code.
n/a
No response
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.