Replace outdated import in the documentation
This commit is contained in:
parent
60b0562311
commit
f0d8c616bb
GPG Key ID:
A27FDC1E8EE902C0
@ -1,5 +0,0 @@
|
||||
# Contributor Code of Conduct
|
||||
|
||||
This project adheres to No Code of Conduct. We are all adults. We accept anyone's contributions. Nothing else matters.
|
||||
|
||||
For more information please visit the [No Code of Conduct](https://github.com/domgetter/NCoC) homepage.
|
||||
107
CONTRIBUTING.md
107
CONTRIBUTING.md
@ -1,107 +0,0 @@
|
||||
|
||||
# Contributing
|
||||
|
||||
Tanya is a project in active development, therefore any help is appreciated. Thank you for considering contributing
|
||||
to it, feel welcome.
|
||||
These guidelines describe ways to get started.
|
||||
|
||||
|
||||
## Ways to get involved
|
||||
|
||||
* **Reporting a problem**: [Report](https://github.com/caraus-ecms/tanya/issues) bugs and usage problems you
|
||||
encounter.
|
||||
* **Fixing issues**: [The bug tracker](https://github.com/caraus-ecms/tanya/issues) contains a list of issues you
|
||||
can work on.
|
||||
* **Documentation**: You can improve API documentation by correcting grammar errors, completing existing texts and
|
||||
writing new ones, or providing usage examples.
|
||||
* **Testing**: Test coverage is important for a library. Writing tests is not only helpful, but is also a great way
|
||||
to get a feel for how tanya works.
|
||||
* **Adding new features**: Tanya is a growing library. If you think some feature is missing, you can suggest
|
||||
and implement this.
|
||||
|
||||
|
||||
## Opening an issue
|
||||
|
||||
If you have found a bug, an error, have some question, or suggestion,
|
||||
[Open an issue](https://github.com/caraus-ecms/tanya/issues). I'll try to answer as soon as I can. There is also a
|
||||
list of open issues that mirror the current development process and progress. If you're looking for a challenge, just
|
||||
pick an issue you are interested in and start working on it. Fill free to comment on the issue to get more
|
||||
information.
|
||||
|
||||
You can also look at the [milestones](https://github.com/Dlackware/gnome/milestones) to see what is planned for a
|
||||
specific release.
|
||||
|
||||
|
||||
## Contribution process
|
||||
|
||||
### Creating a pull request
|
||||
|
||||
I accept GitHub pull requests. Creating a pull request is like sending a patch with the suggested change.
|
||||
First you have to [fork](https://guides.github.com/activities/forking/) the repository. Clone your fork locally
|
||||
with `git clone` and create a new branch where you want to work. For example:
|
||||
|
||||
```shell
|
||||
git checkout -b bugfix-x
|
||||
```
|
||||
Commit your changes to your fork:
|
||||
|
||||
```shell
|
||||
git commit -m "Fix X"
|
||||
git push -u origin bugfix-x
|
||||
```
|
||||
|
||||
After that if you visit your fork on GitHub, GitHub will suggest to create pull request. Just follow the steps
|
||||
described on GitHub to finish the process. See
|
||||
[Using Pull Requests](https://help.github.com/articles/about-pull-requests/) for more information.
|
||||
|
||||
Please ensure that your fork is even with the upstream (original) repository. If not, you have to rebase your branch
|
||||
on upstream/master before submitting the pull request. See [Syncing a fork](https://help.github.com/articles/syncing-a-fork/) for a
|
||||
step-by-step guide.
|
||||
|
||||
### Fixing a bug
|
||||
|
||||
Add a unit test that demonstrates the bug along with a short description or link to the original bug.
|
||||
|
||||
### Adding new features
|
||||
|
||||
* Use Ddoc to document the feature.
|
||||
* Add some unit tests to prevent bugs.
|
||||
* [Documented D unit tests](https://dlang.org/spec/ddoc.html#using_ddoc_to_generate_examples) go into the documentation and can be used as an usage
|
||||
example. These tests should be readable and not complicated since they demonstrate how the feature is supposed to work.
|
||||
* More advanced tests should be put into a separate not documented unittest block.
|
||||
|
||||
### Writing unit tests
|
||||
|
||||
```d
|
||||
///
|
||||
unittest
|
||||
{
|
||||
// A documented unit test has three slashes in front of it.
|
||||
}
|
||||
|
||||
// Issue ##: https://github.com/caraus-ecms/tanya/issues/##.
|
||||
unittest
|
||||
{
|
||||
// Not documented unit test may still have a description.
|
||||
}
|
||||
```
|
||||
|
||||
### Style guide
|
||||
|
||||
Make sure your changes follow [The D Style](https://dlang.org/dstyle.html) (including
|
||||
[Additional Requirements for Phobos](https://dlang.org/dstyle.html#phobos)).
|
||||
|
||||
You can also use [dscanner](https://github.com/dlang-community/D-Scanner) to test the new code against the
|
||||
most guidlines. The root of this repository contains
|
||||
[dscanner.ini](https://github.com/caraus-ecms/tanya/blob/master/dscanner.ini), configuration file with settings for an
|
||||
automatic style check. Just go to the top-level directory and issue (this assumes `dscanner` is installed in your
|
||||
system):
|
||||
|
||||
```shell
|
||||
dscanner --styleCheck source
|
||||
```
|
||||
|
||||
## Questions and suggestions
|
||||
|
||||
* [Open an issue](https://github.com/caraus-ecms/tanya/issues)
|
||||
* [Send an email](mailto:info@caraus.de)
|
||||
@ -3,7 +3,7 @@
|
||||
[](https://build.caraus.tech/go/pipelines)
|
||||
[](https://code.dlang.org/packages/tanya)
|
||||
[](https://code.dlang.org/packages/tanya)
|
||||
[](https://raw.githubusercontent.com/caraus-ecms/tanya/master/LICENSE)
|
||||
[](https://opensource.org/licenses/MPL-2.0)
|
||||
|
||||
Tanya is a general purpose library for D programming language.
|
||||
|
||||
@ -13,9 +13,7 @@ Garbage Collector heap. Everything in the library is usable in @nogc code.
|
||||
Tanya provides data structures and utilities to facilitate painless systems
|
||||
programming in D.
|
||||
|
||||
* [API Documentation](https://docs.caraus.io/tanya)
|
||||
* [Contribution guidelines](CONTRIBUTING.md)
|
||||
|
||||
- [API Documentation](https://docs.caraus.io/tanya)
|
||||
|
||||
## Overview
|
||||
|
||||
@ -193,4 +191,4 @@ aren't supported
|
||||
## Feedback
|
||||
|
||||
Any feedback about your experience with tanya would be greatly appreciated. Feel free to
|
||||
[contact me](mailto:info@caraus.de).
|
||||
[contact me](mailto:belka@caraus.de).
|
||||
|
||||
@ -37,7 +37,7 @@ else version (D_Ddoc)
|
||||
|
||||
version (WindowsDoc):
|
||||
|
||||
import tanya.sys.windows.winbase;
|
||||
import core.sys.windows.winbase;
|
||||
|
||||
/**
|
||||
* Provides an extendable representation of a Win32 $(D_PSYMBOL OVERLAPPED)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user