Fix error: "C++ style comments are not allowed in ISO C90" make compilation on MSYS2 MinGW64 #448
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
libxlsxwriter: Submitting Pull Requests
Pull Requests and Contributing to Libxlsxwriter
All patches and pull requests are welcome but in general you should start with
an issue tracker to describe what you intend to do before you do it.
Getting Started
tracker][issues]. This serves as the focal point for the design discussion.
example to demonstrate them.
make test
. See the Running the Test Suite section of the docsfor instructions.
Code Style
The code style is mainly K&R style with 4 space indents.
The author uses GNU indent (
gindent
) 2.2.10 with the following options:The indent configuration file is available in the repo. The code
can be indented automatically if the same version of
gindent
is used withthe following make command:
Note, make sure you have backed up your files or added them to the index
before running this command.
In general follow the existing style in the code.
Writing and Running Tests
Any significant features should be accompanied by a test. See the
test
directory and the Running the Test Suite section of the docs for
details of the test setup.
The tests can be run as follows:
make test
Same as:
The functional tests require the Python module pytest as a test runner.
If you have
valgrind
installed you can use the test suite to check for memory leaks:When you push your changes they will also be tested automatically using
GitHub Actions.
Documentation
The
libxlsxwriter
documentation is written in Doxygen format in the headerfiles and in additional
.dox
files in thedocs/src
directory of therepo. The documentation can be built as follows:
Example programs
If applicable add an example program to the
examples
directory. Examplefiles can be built using:
Copyright and License
Copyright remains with the original author. Do not include additional
copyright claims or Licensing requirements. GitHub and the
git
repositorywill record your contribution and it will be acknowledged it in the Changes
file.
Submitting the Pull Request
If your change involves several incremental
git
commits thenrebase
orsquash
them onto another branch so that the Pull Request is a single commitor a small number of logical commits.
Push your changes to GitHub and submit the Pull Request with a hash link to
the to the Issue tracker that was opened above.