Thank you for considering contributing to Gepsio! It's people like you that make Gepsio such a great library.
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
Gepsio is an open source project and we love to receive contributions from our community — you! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into Gepsio itself.
The project would love to hear from you!
Feel free to reach the project administrators via social media or email. The project maintains a Wiki page which lists the various ways to reach the project administrators.
Gepsio uses the GitFlow branching strategy. In this strategy, there are two long-lived branches:
masterdevelop
The master branch contains the code that has been published out as a NuGet package. The develop branch contains the code currently under development and ready for a future release. New code is developed under the develop branch, and only the Release-to-NuGet workflow will update master with the contents of develop. The master branch is never directly accessed.
If you would like to modify the code and present a pull request, please do the following:
- Create a feature/fix branch off of the
developbranch. - Perform your work on the feature/fix branch. The name of the branch doesn't matter, as long as it is branched off of the
developbranch. - Present the feature/fix branch for consideration as a pull request.
- When the pull request is accepted, then the work will be pulled into the
developbranch.
When a release is imminent, the project administrators will merge the develop branch into the master branch, and the code in the master branch will be labeled and readied for release as a NuGet package.
Pull requests should include unit tests. Pull requests that address a logged issue should include at least one unit test that execrcises the issue.
The solution includes a project called JeffFerguson.Gepsio.Test. This project includes a subdirectory called IssueTests. Unit tests that exercise an issue should be placed within this subdirectory. Each issue should have their own subdirectory beneath the IssueTests subdirectory, and the subdirectory should be named with the issue number being exercised by the unit test.
For example, the solution contains a unit test to exercise Issue 1. The JeffFerguson.Gepsio.Test project includes a subfolder called \IssueTests\1, and the subdirectory includes a unit test to exercise Issue 1.
The Gepsio code base contains a series of unit tests. One of the unit tests runs the XBRL Conformance Suite against Gepsio, while other unit tests run to ensure that issues logged against Gepsio have been corrected.
From the command line, you can use the dotnet CLI to run Gepsio unit tests, as in the examples shown below.
To run all of Gepsio's unit tests from the command line, use the CLI command dotnet test.
To run only the Gepsio unit test that test Gepsio's compliance against the XBRL specification using the XBRL Conformance Suite, use the CLI command dotnet test --filter JeffFerguson.Gepsio.Test.XbrlConformanceTest.ExecuteXBRLCONF20141210Testcases. When Gepsio is fully compliant with the XBRL specification, this unit test will pass. Until Gepsio is fully compliant, this unit test will fail.
To run only the Gepsio unit tests that have been written to test a previously logged issue without also running the XBRL Conformance Suite tests, use the CLI command dotnet test --filter FullyQualifiedName!=JeffFerguson.Gepsio.Test.XbrlConformanceTest.ExecuteXBRLCONF20141210Testcases.
Thank you once again for your willingness to make a contribution to the project!