Skip to content

Commit

Permalink
2020-11-14 01:40 UTC Viktor Szakats ([email protected]) [ci skip]
Browse files Browse the repository at this point in the history
  * *
    * URL and README updates
  • Loading branch information
vszakats committed Nov 14, 2020
1 parent f4eecf2 commit ed163a2
Show file tree
Hide file tree
Showing 660 changed files with 8,897 additions and 8,932 deletions.
93 changes: 48 additions & 45 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to this fork of Harbour

# Table of Content
# Table of Contents

1. [How to Donate](#how-to-donate)
2. [How to Share](#how-to-share)
Expand All @@ -26,40 +26,40 @@

Examples:

* [commit](https://github.com/vszakats/harbour-core/commit/35ffdc113f348fbf10203757073bbee564e4339f)
* [commit - specific file](https://github.com/vszakats/harbour-core/commit/35ffdc113f348fbf10203757073bbee564e4339f#diff-2)
* [issue](https://github.com/vszakats/harbour-core/issues/18)
* [issue comment](https://github.com/vszakats/harbour-core/issues/22#issuecomment-47928889)
* [commit](https://github.com/vszakats/hb/commit/35ffdc113f348fbf10203757073bbee564e4339f)
* [commit - specific file](https://github.com/vszakats/hb/commit/35ffdc113f348fbf10203757073bbee564e4339f#diff-2)
* [issue](https://github.com/vszakats/hb/issues/18)
* [issue comment](https://github.com/vszakats/hb/issues/22#issuecomment-47928889)
* [source file](tests/hello.prg)
* [source file - specific revision](https://github.com/vszakats/harbour-core/blob/dd2c3b3e9c0e7db7f1c18be2a079dc92f983122e/tests/hello.prg) ([more information here](https://help.github.com/articles/getting-permanent-links-to-files))
* [source line](https://github.com/vszakats/harbour-core/blob/dd2c3b3e9c0e7db7f1c18be2a079dc92f983122e/tests/hello.prg#L5)
* [source section](https://github.com/vszakats/harbour-core/blob/90ce13098244b0e27fc4b8c7af5586f892a09337/src/rtl/chruni.c#L101-L112)
* [source file - specific revision](https://github.com/vszakats/hb/blob/dd2c3b3e9c0e7db7f1c18be2a079dc92f983122e/tests/hello.prg) ([more information here](https://help.github.com/articles/getting-permanent-links-to-files))
* [source line](https://github.com/vszakats/hb/blob/dd2c3b3e9c0e7db7f1c18be2a079dc92f983122e/tests/hello.prg#L5)
* [source section](https://github.com/vszakats/hb/blob/90ce13098244b0e27fc4b8c7af5586f892a09337/src/rtl/chruni.c#L101-L112)
* [source directory](contrib/hbcurl/)
* [source - specific revision](https://github.com/vszakats/harbour-core/tree/e46f2fdb75c493ff5b4c777f5a0963d2e7d6f65b)
* [source - specific revision .zip archive](https://github.com/vszakats/harbour-core/archive/e46f2fdb75c493ff5b4c777f5a0963d2e7d6f65b.zip)
* [source - specific revision](https://github.com/vszakats/hb/tree/e46f2fdb75c493ff5b4c777f5a0963d2e7d6f65b)
* [source - specific revision .zip archive](https://github.com/vszakats/hb/archive/e46f2fdb75c493ff5b4c777f5a0963d2e7d6f65b.zip)


# How to Get Involved

- You can give feedback/suggestions by submitting an [issue](https://github.com/vszakats/harbour-core/issues/new).
- You can give feedback/suggestions by submitting an [issue](https://github.com/vszakats/hb/issues/new).
- Submit a patch:
1. Fork the repository
2. Create a branch: `git checkout -b mypatch`
2. Create a branch: `git switch -c mypatch`
or `git checkout -b mypatch` (for Git 2.22.x and earlier)
3. Do commit pre-check and new log entry: `hbrun bin/commit`
4. Commit your changes: `git commit -am "Add this feature to that module"`
5. Push to the branch: `git push origin mypatch`
6. Open a Pull Request
- Make sure to use the same coding/formatting style as you find in the files
you're modifying. The easiest way to achieve this is to use these commands
to format the sources (use this with care - most existing sources are
well-formatted, so make sure to only apply it to newly added or modified
code sections)
you're updating. The easiest way to achieve this is to use these commands
to format the sources (use this with care - most sources are well-formatted,
so make sure to only apply it to newly added or updated code sections)

$ uncrustify -c <harbour-dir>/bin/harbour.ucf <source{.c|.h}>
$ <harbour-dir>/bin/hbformat <source{.prg|.hb|.ch}>

- Text editor setting for Harbour files
- Encoding is either 7-bit ASCII or [UTF-8](http://utf8everywhere.org/),
- Encoding is either 7-bit ASCII or [UTF-8](https://utf8everywhere.org/),
without [BOM](https://en.wikipedia.org/wiki/Byte_order_mark)
- Use spaces (U+0020), never tabs or non-breaking spaces
- Remove trailing spaces from lines
Expand All @@ -77,7 +77,7 @@
- If looking for known pending issues to work on, look for `TODO` and `FIXME`
markers in the source code/ChangeLog or see this list of issues that need
further input/contribution:
* https://github.com/vszakats/harbour-core/issues?q=label%3A%22help+wanted%22
* https://github.com/vszakats/hb/issues?q=label%3A%22help+wanted%22
* https://github.com/harbour/core/issues?q=label%3A%22help+wanted%22


Expand All @@ -92,9 +92,9 @@ Evaluate these points before reporting an issue:
source tree in a new local directory and start over. See
[How to Get](../README.md#how-to-get) for instructions to get the source.
In case you installed Harbour into system locations (this used to be the
case with some \*nix users, albeit mostly completely unnecessarily or
wrongly - f.e. for unstable versions), you will need to remember cleaning
off Harbour from all of these locations, too.
case with some \*nix users, albeit mostly unnecessarily or wrongly - e.g.
for unstable versions), you will need to remember cleaning off Harbour
from these locations, too.
Hint: Never install unstable Harbour versions to system locations.
4. <a name="trbl-4"></a> If you are doing a cross-build, make sure to have
rebuilt the native Harbour executables for your host platform.
Expand All @@ -106,15 +106,15 @@ Evaluate these points before reporting an issue:
set PATH=C:\<c-compiler-bin-dir>

> If you use Harbour official binary distro on Windows, even above is
> unnecessary and should be avoided.
> unnecessary, so avoid it.
6. <a name="trbl-6"></a> Remove all old, unnecessary environment variables
(for both Harbour and C compiler) from your environment. Also remove
any custom settings for your C compiler.
Use only those documented in this file.
7. <a name="trbl-7"></a> Remove any Harbour build settings documented in
[Build Options](../README.md#build-options).
8. <a name="trbl-8"></a> Do no or only minor modifications at once to the
examples included in [Build Examples](../README.md#build-examples).
8. <a name="trbl-8"></a> Do no or only minor updates at once to the examples
included in [Build Examples](../README.md#build-examples).
If it doesn't work, fall back to documented examples _as is_.
9. <a name="trbl-9"></a> If everything fails and you are to report a build
problem to Harbour developers, make sure to include your OS
Expand All @@ -139,39 +139,42 @@ Evaluate these points before reporting an issue:
output to a file (see above how). Also include your full command-line
and any referenced build script in your report.
It is good idea to first remove all manual references to Harbour
core components from make-files and custom environment. F.e. it's
core components from make-files and custom environment. E.g. it's
common mistake to add C compiler header and/or lib dirs, Harbour core
header and/or lib dirs, built-in constants to make-files or environment.
No such thing is necessary as all of these are automatically handled
by `hbmk2`. In other words: start simple and don't be over-busy with
*fine-tuning* your configuration. If you need to, the problem is most
probably elsewhere. It's also good idea to try with the latest Harbour
revision or Harbour's mainline branch first.
No such thing is necessary as these are automatically handled by `hbmk2`.
In other words: start simple and don't be over-busy with *fine-tuning*
your configuration. If you need to, the problem is most probably
elsewhere. It's also good idea to try with the latest Harbour revision or
Harbour's mainline branch first.
12. <a name="trbl-12"></a> If you are to report a problem with Harbour itself,
provide self-contained, minimal source code example. Do not use `xhb`
include self-contained, minimal source code example. Do not use `xhb`
contrib library (including `hbcompat.ch`), nor any 3rd party Harbour
libraries.
The example shall reproduce the problem using the latest Harbour revision
(with _no_ local commits or pending local modifications) at the time of
the report. Do not post links to executables and other binary files. If
The example should reproduce the problem using the latest Harbour revision
(with _no_ local commits or pending local updates) at the time of the
report. Do not post links to executables and other binary files. If
your source contains non-ASCII and non-UTF-8 national, accented, special
chars, make sure to mark the codepage/encoding used and use
`Chr()`/`hb_BCode()` calls to form the strings. Use UTF-8 if possible.
Notice that code examples are likely to be executed as `hbrun` scripts
for testing, so it's a good idea to make them work this way.<br>
Notice that core developers are likely to run code examples as `hbrun`
scripts for testing, so it's a good idea to make them work this way.<br>
Also make sure not to report multiple issues under a single
GitHub Issue.<br>
* See more on self-contained examples:
* <http://sscce.org/>
* <https://stackoverflow.com/help/mcve>
* See more on how to report issues in an effective and useful way:
* More on self-contained examples:
<https://en.wikipedia.org/wiki/Minimal_working_example>
* More on how to report issues in an effective and useful way:
<https://www.chiark.greenend.org.uk/~sgtatham/bugs.html>
* "How To Ask Questions The Smart Way" article by Eric S. Raymond:
<http://www.catb.org/~esr/faqs/smart-questions.html>
* "How to ask good questions" by Julia Evans
<http://catb.org/~esr/faqs/smart-questions.html>
* "How to Ask Good Questions" by Julia Evans
<https://jvns.ca/blog/good-questions/>
* "Question Checklist" by Jon Skeet
<https://codeblog.jonskeet.uk/2012/11/24/stack-overflow-question-checklist/>
* "Does Not Work"
<http://importblogkit.com/2015/07/does-not-work/>
<https://web.archive.org/web/20180124130721/importblogkit.com/2015/07/does-not-work/>
* "The XY Problem"
<https://meta.stackexchange.com/questions/66377/what-is-the-xy-problem/66378#66378>
13. <a name="trbl-13"></a> Please do not report warnings or bugs &mdash; except
_build errors_ &mdash; in 3rd party components hosted inside the Harbour
source tree. You can recognize these by their source path, which always
Expand All @@ -190,5 +193,5 @@ Evaluate these points before reporting an issue:


---
This document Copyright &copy;&nbsp;2009&ndash;present Viktor Szakats (vszakats.net/harbour)<br>
[![Creative Commons Attribution-ShareAlike 4.0](https://mirrors.creativecommons.org/presskit/buttons/80x15/svg/by-sa.svg)](https://creativecommons.org/licenses/by-sa/4.0/)
This document Copyright &copy;&nbsp;2009&ndash;present Viktor Szakats (vsz.me/hb)<br>
[![Creative Commons Attribution-ShareAlike 4.0](https://vsz.me/assets/img/cc-by-sa.svg)](https://creativecommons.org/licenses/by-sa/4.0/)
Loading

0 comments on commit ed163a2

Please sign in to comment.