Firstly, thanks for taking the time to contribute!
The following is a set of guidelines for contributing to this project, which are hosted in the Lyquidity Organization on GitHub. These are just guidelines, not rules. Use your best judgement, and feel free to propose changes to this document in a pull request.
What should I know before I get started?
This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to xml-github@lyquidity.com.
The source code has been developed to allow XBRL taxonomies and instance documents that conform to the XBRL 2.1 specification and the XBRL Dimensions 1.0
While it is not expected that someone wanting to use the source code provided by this project will be familiar with the detail of these specifications it is expected that people wanting to make contributions to the project source will be very familiar with these and other XBRL specifications.
The project source has been created using the PHP programming language.
The source code takes advantage of features provided by this language including, but not limited to, classes, namespaces,
closures and reference passing.
This source code is designed to support PHP 7.0 and later. We recommend PHP 7.1.6.
This section guides you through submitting a bug report for XBRLQuery/core. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. If you'd like, you can use this template to structure the information.
- Check the issues list You might be able to find the cause of the problem and fix things yourself or that it has bee reported.
- Check if you can reproduce the problem Always check against the latest version. Although you may want to use an older version, if the issue no longer exists it will mean you can find out how the issue was fixed and create a patch.
Bugs are tracked as GitHub issues. After you've determined which file your bug can be found in, create an issue and provide the following information.
Explain the problem and include additional details to help maintainers reproduce the problem:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible. For example, include the branch you have used, the taxonomy you are using and the instance document you are using. explaining how you started Atom, e.g. which command exactly you used in the terminal, or how you started Atom otherwise. When listing steps, don't just say what you did, but explain how you did it. For example, if you moved the cursor to the end of a line, explain if you used the mouse, or a keyboard shortcut or an Atom command, and if so which one?
- Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
Include details about your configuration and environment:
- Which version of PHP are you using? You can get the exact version by running
php -versionin your terminal. - What's the name and version of the OS you're using?
- Which version of the source code do you have installed?
[Short description of problem here]
**Reproduction Steps:**
1. [First Step]
2. [Second Step]
3. [Other Steps...]
**Expected behavior:**
[Describe expected behavior here]
**Observed behavior:**
[Describe observed behavior here]
**Screenshots**
**PHP version:** [Enter PHP version here]
**OS and version:** [Enter OS name and version here]
**Installed PHP extensions:**
[List of installed PHP extensions here]
**Additional information:**
* Problem can be reproduced in all versions of PHP: [Yes/No]
* Problem started happening recently, didn't happen in an older version: [Yes/No]
* Problem can be reliably reproduced, doesn't happen randomly: [Yes/No]
* Problem happens with all taxonomies and instance documents, not only some: [Yes/No]
This section guides you through submitting an enhancement suggestion for XBRLQuery/core, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.
Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible. If you'd like, you can use this template to structure the information.
- Check if there's already feature which provides that enhancement. Sometimes changing the way you think about a problem can lead to the use of existing features in new ways.
- Determine which file the enhancement should affect. Is the suggestion to core taxonomy handling, a specific taxonomy, instance document handing or reporting.
- Perform a cursory search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
- Make sure it is not already one the road map
Enhancement suggestions are tracked as GitHub issues. Create an issue and provide the following information:
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of XBRLQuery/code the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
- Explain why this enhancement would be useful to most XBRLQuery users and isn't something that can or should be implemented as a separate package.
- List some other XBRL tools or applications where this enhancement exists.
- Specify which version of PHP you're using. You can get the exact version by running
php -versionin your terminal. - Specify the name and version of the OS you're using.
[Short description of suggestion]
**Steps which explain the enhancement**
1. [First Step]
2. [Second Step]
3. [Other Steps...]
**Current and suggested behavior**
[Describe current and suggested behavior here]
**Why would the enhancement be useful to most users**
[Explain why the enhancement would be useful to most users]
[List some other text editors or applications where this enhancement exists]
**Screenshots and GIFs**
**PHP Version:** [Enter PHP version here]
**OS and Version:** [Enter OS name and version here]
Unsure where to begin contributing to Atom? You can start by looking through these beginner and help-wanted issues:
- Beginner issues - issues which should only require a few lines of code, and a test or two.
- Help wanted issues - issues which should be a bit more involved than
beginnerissues.
Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.
- Include DocBlock-style comments for all functions, properties and classes. Also add a DocBlock-style comment at the top of each file.
- Include thoughtfully-worded, well-structured tests and include the test in the
./testsfolder. - Avoid platform-dependent code.
- It must be possible to run the code under PHP 5.3.x or later and PHP 7.x
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally
- When only changing documentation, include
[ci skip]in the commit description
This section lists the labels we use to help us track and manage issues and pull requests.
GitHub search makes it easy to use labels for finding
groups of issues or pull requests you're interested in. For example, you might be interested in
[open issues across xbrlquery/core and all issue that are labeled as bugs, but still need to be reliably reproduced]
(https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+user%3Axbrlquery+label%3Abug+label%3Aneeds-reproduction)
or perhaps
[open pull requests in xbrlquery/core which haven't been reviewed yet]
(https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Apr+repo%3Acore%2Fcore+comments%3A0).
To help you find issues and pull requests, each label is listed with search links for
finding open items with that label in xbrlquery/core only and also across all Atom repositories.
We encourage you to read about other search filters which
will help you write more focused queries.
The labels are loosely grouped by their purpose, but it's not required that every issue have a label from every group or that an issue can't have more than one label from the same group.
Please open an issue on xbrlquery/core if you have suggestions for new labels, and if you notice some labels are
missing, then please open an issue.
| Label name | xbrlquery/core |
Description |
|---|---|---|
enhancement |
search | Feature requests. |
bug |
search | Confirmed bugs or reports that are very likely to be bugs. |
question |
search | Questions more than bug reports or feature requests (e.g. how do I do X). |
feedback |
search | General feedback more than bug reports or feature requests. |
help-wanted |
search | The Atom core team would appreciate help from the community in resolving these issues. |
beginner |
search | Less complex issues which would be good first issues to work on for users who want to contribute to Atom. |
more-information-needed |
search | More information needs to be collected about these problems or feature requests (e.g. steps to reproduce). |
needs-reproduction |
search | Likely bugs, but haven't been reliably reproduced. |
blocked |
search | Issues blocked on other issues. |
duplicate |
search | Issues which are duplicates of other issues, i.e. they have been reported before. |
wontfix |
search | The Atom core team has decided not to fix these issues for now, either because they're working as intended or for some other reason. |
invalid |
search | Issues which aren't valid (e.g. user errors). |
| Label name | xbrlquery/core |
Description |
|---|---|---|
windows |
search | Related to Atom running on Windows. |
linux |
search | Related to Atom running on Linux. |
mac |
search | Related to Atom running on macOS. |
documentation |
search | Related to any type of documentation. |
performance |
search | Related to performance. |
security |
search | Related to security. |
ui |
search | Related to visual design. |
api |
search | Related to Atom's public APIs. |
uncaught-exception |
search | Issues about uncaught exceptions. |
crash |
search | Reports of Atom completely crashing. |
encoding |
search | Related to character encoding. |
network |
search | Related to network problems or working with remote files (e.g. on network drives). |
git |
search | Related to Git functionality (e.g. problems with gitignore files or with showing the correct file status). |
parse |
search | Reports of code causing PHP fatal errors. |
load-taxonomy |
search | Issues relating to reading a taxonomy. |
compile-taxonomy |
search | Issues relating to compiling taxonomy. |
instance-document |
search | Issues relating loading or using instance documents. |
reporting |
search | Issues relating to creating reports using the reports classes. |
| Label name | xbrlquery/core |
Description |
|---|---|---|
work-in-progress |
search | Pull requests which are still being worked on, more changes will follow. |
needs-review |
search | Pull requests which need code review, and approval from maintainers or Atom core team. |
under-review |
search | Pull requests being reviewed by maintainers or Atom core team. |
requires-changes |
search | Pull requests which need to be updated based on review comments and then reviewed again. |
needs-testing |
search | Pull requests which need manual testing. |