-
Notifications
You must be signed in to change notification settings - Fork 17
1. Contributing.
Your patches, issues, ideas and bug reports are essential for getting libDXF better and achieving a great library of DXF routines and tools. We simply can't access the huge number of platforms and myriad configurations for running libDXF. We want to keep it as easy as possible to contribute changes that get things working in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
On Github:
- Make sure you have a GitHub account.
- Submit a ticket for your issue, assuming one does not already exist.
- Clearly describe the issue including steps to reproduce when it is a bug.
- Make sure you mention the earliest version that you know has the issue.
- Fork the repository on GitHub if you are going to create a patch, and do a "pull request", this is best done on a separate topic branch.
Or on Launchpad:
- Make sure you have a Launchpad account.
- Sign the Code of Conduct.
- Submit a bug report for your issue, assuming one does not already exist.
- Clearly describe the issue including steps to reproduce when it is a bug.
- Make sure you mention the earliest version that you know has the issue.
Create a topic branch from where you want to base your work. This is usually the master branch. Only target release branches if you are certain your fix must be on that branch. To quickly create a topic branch based on master with:
git branch fix/master/my_contribution master
then checkout the new branch with:
git checkout fix/master/my_contribution
Please avoid working directly on the master branch. Make commits of logical units. Check for unnecessary white space with git diff --check before committing. Make sure your commit messages are in the proper format:
(#99999) Make the example in CONTRIBUTING imperative and concrete
Without this patch applied the example commit message in the CONTRIBUTING
document is not a concrete example. This is a problem because the
contributor is left to imagine what the commit message should look like
based on a description rather than an example. This patch fixes the
problem by making the example concrete and imperative.
The first line is a real life imperative statement with a ticket number from the Github issue tracker. The body describes the behavior without the patch, why this is a problem, and how the patch fixes the problem when applied.
Make sure you have added the necessary tests for your changes. Run all the tests to assure nothing else was accidentally broken.
On Github:
- Push your changes to a topic branch in your fork of the repository.
- Submit a pull request to the repositories in the libDXF organization.
Or on Launchpad:
- Sign the Code of Conduct, if you haven't done that yet.
- Update your Launchpad bug report to mark that you have submitted code and are ready for it to be reviewed.
- Include a link to the pull request or topic branch in the bug report.
Last update: November 2nd, 2017.