When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct, please follow it in all your interactions with the project.
- Proposing enhancements, reporting bugs and other issues
- Testing
- Pull Request Process
- Release process
- Code of Conduct
Before suggesting an enhancement, new feature, or reporting a bug, required change due to GitHub API change or any other issue please browse or search project issues and pull requests.
If you find a matching issue please contribute there with a comment.
If you do not find any please feel free creating an issue or opening a pull request.
Please consider including code fragments, logs and/or links to support your bug report or enhancement whether it is an issue or a pull request.
When proposing an enhancement via a pull request consider implementation that would not break experience of the project users, securing backward compatibility, if possible.
Feel free forking the project.
Please test your proposal submitted via a pull request. GitHub workflows allow specifying an action's version. This might be a versioning tag, a commit or a branch name.
Testing tools and guidelines to consider:
- https://github.com/OleksiyRudenko/gha-git-credentials-test
- https://github.com/tschoffelen/gha
- https://github.com/nektos/act
- https://docs.github.com/en/free-pro-team@latest/actions/creating-actions/creating-a-javascript-action#testing-out-your-action-in-a-workflow
- https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the
README.mdwith details of changes to the interface, this includes new environment variables, API, useful file locations and container parameters if any. - Increase the version numbers in any examples files and
the
README.md,package.jsonto the new version that this Pull Request would represent. UpdateCHANGELOG.mdwith version features description. The versioning scheme we use is SemVer. - You may merge the Pull Request in once you have the sign-off of one other maintainer, or if you do not have permission to do that, you may request any maintainer to merge it for you.
Consider having Resolves #<issue-reference> in either of your commits
if there is any relevant issue open. This will close the issue once
the PR is approved and merged.
- Publish code changes
- Advertise release candidate
- Test release candidate
- Tag new release
- Update docs
- Publish release
This action deployment workflow uses itself to build its own distribution package.
Deployment action is triggered once a commit introducing a change to
either of the files specified under on clause
in .github/workflows/deploy.yml
is pushed to master branch on GitHub.
The action creates a distribution package, commits,
sets (forcedly) rc (Release Candidate) tag and
pushes the change.
Invite maintainers, contributors and key users to test the Release Candidate and report any bugs or confirm that no issues are detected.
- Trigger test at gha-git-credentials-test
- Check kottans/frontend-2022-homeworks actions log.
See recent daily
Update students' PR statsworkflow run. It uses thercversion of the action. Make sure that reviewed workflow run time is relevant to the tested RC version. - Run other tests as appropriate.
- Pull the latest changes from the remote
- Run
npm set-version-tags X Y Zto setvX.Y.Z,vX.Y-latest,vX-latest, andlatesttags
README.mdsections: Inputs, Outputs, Usage Example, VersionsCHANGELOG.mdpackage.json/version- run
npm run generate-toc
Create and publish a release publishing this Action to the GitHub Marketplace.
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
Examples of behavior that contributes to creating a positive environment include:
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team via project issues. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4