Welcome! If you're viewing this, it means that you are likely interested in contributing to the project. That's marvelous!
The following is a set of guidelines for contributing to
igir. These guidelines are published in order to clarify expectations and reduce potential conflict of opinions.
Feature requests & bug reports
Feedback is a gift! Your feature requests and bug reports help improve the project for everyone.
If you have an idea for a new feature, please search for if an active issue already exists. If an existing issue doesn't already exist, please submit a detailed feature request in GitHub. If you're not sure if your idea is ready for a full request, feel free to start a discussion in GitHub for feedback instead - it can always be turned into a feature request later!
If you are experiencing an issues, please submit a detailed bug report in GitHub.
GitHub discussions are a great tool for a number of topics:
- Getting help with
igirCLI syntax or usage
- Clarifying support for specific features or scenarios
- Brainstorming new feature requests
- ...and more!
Discussions are intended to be low-pressure spaces for questions and collaboration, please feel free to use them openly!
First, you will want to check out
igir's source code from GitHub:
igir is written in TypeScript for the Node.js runtime. The current version of Node.js that
igir uses is defined under the
"volta" object in the
package.json file. After installing, Volta will make sure you're always using the correct Node.js version.
Third-party dependencies are managed and easily installed with npm:
Scripts are defined for common npm commands:
A script has been defined for the
npm start command to easily run
igir uses ESLint as its linter and style enforcer. Rules have been specifically chosen to increase code consistency, safety, readability, and maintainability.
All code changes must pass the existing ESLint rules. Discussions on adding, removing, and changing ESLint rules should happen outside of pull requests that contain code changes, in their own dedicated pull request or discussion thread (above).
All code changes must come with appropriate automated tests in order to prove correctness and to protect against future regressions.
igir uses MkDocs to turn Markdown files into a documentation website.
Appropriate updates must be made to all relevant documentation pages if functionality is added, removed, or changed.
Git commit messages
igir is configured to squash-merge all pull requests, such that only the pull request title ends up in the commit history of the main branch. This means that individual commit messages are less important, and it puts more emphasis on quality pull request titles & descriptions.
That said, quality commit messages help future maintainers understand past intentions. Please use your best judgement on descriptive, clear, and concise commit messages.
Pull request checklist
Here are steps that should be completed prior to submitting a pull request:
- [ ] Validate your change works as expected locally by running
igir(not just the unit tests)
- [ ] Unit tests have been added to cover your change
- [ ]
npm testhas been run locally for your change, to validate:
- Your added & changed tests are passing
- Your added & changed code adheres to the linter settings
- [ ] Appropriate docs have been added or changed for your change
- [ ] Your branch has no conflicts with the main (destination) branch
To contribute code changes, you will need to:
- Fork the repository
- Create a new branch in your copy of the repository
- Make any intended changes
- Complete the above pull request checklist
- Create a pull request, complete with a meaningful title & description
- Ensure that all GitHub status checks are passing, otherwise address the related issue(s)
- Running tests in GitHub may require maintainer approval
igir is licensed under GNU General Public License v3.0.
✅ That means that
igir can be used for free commercially, can be modified, can be distributed, and can be used for private use.
⚠️ But it also means that distribution of closed-source versions is not allowed.