From 21dc0bccfb1d5f62fa74739f91d72eaa11b23b49 Mon Sep 17 00:00:00 2001 From: Roger Barker Date: Thu, 16 Jan 2025 23:51:28 -0600 Subject: [PATCH 1/3] Add readme definition Signed-off-by: Roger Barker --- README.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 85f1a3e..a53e297 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,34 @@ # setup-git-semver -Github action to setup git-semver for use in github workflows + +A GitHub Action to set up the [git-semver](https://github.com/PSanetra/git-semver) tool in your GitHub workflows. This action installs and configures `git-semver` for versioning and semantic versioning tasks, allowing you to use it seamlessly in your CI/CD pipeline. + +## Usage + +You can use this action in your GitHub workflow to set up `git-semver`. Below is an example of how to use the action: + +### Basic Example + +```yaml +name: Set up Git-Semver + +on: + push: + branches: + - main + workflow_dispatch: + +jobs: + setup-git-semver: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v2 + + - name: Set up git-semver + uses: DJ-BBot/setup-git-semver@v1 + with: + version: 'latest' + + - name: Use git-semver + run: git-semver From 9c737ad0666ee71d1f93e06272ed5fb09a9304ba Mon Sep 17 00:00:00 2001 From: Roger Barker Date: Thu, 16 Jan 2025 23:58:38 -0600 Subject: [PATCH 2/3] dded CODE_OF_CONDUCT and CONTRIBUTING.md Signed-off-by: Roger Barker --- .github/CONTRIBUTING.md | 84 +++++++++++++++++++++++++++++++++++++++++ CODE_OF_CONDUCT.md | 54 ++++++++++++++++++++++++++ 2 files changed, 138 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 CODE_OF_CONDUCT.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..63efb86 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,84 @@ +# Contributing to setup-git-semver + +Thank you for your interest in contributing to the `setup-git-semver` project! Whether you're submitting a bug report, fixing a bug, or adding a feature, we appreciate your help in making this action better. + +## How to Contribute + +### Reporting Issues + +If you've encountered a bug or have a suggestion for improvement, please check the [Issues](https://github.com/DJ-BBot/setup-git-semver/issues) tab to see if it's already been reported. If not, feel free to open a new issue with as much detail as possible, including: + +- A clear description of the problem or feature request. +- Steps to reproduce the issue (if applicable). +- The expected behavior and any error messages. +- Your environment details (e.g., operating system, GitHub Actions version). + +### Submitting a Pull Request + +We welcome contributions through pull requests! To submit a pull request: + +1. **Fork the repository**: + Click the "Fork" button at the top of the repository page to create a copy of the project under your GitHub account. + +2. **Clone your fork**: + Clone your forked repository to your local machine: + ```bash + git clone https://github.com/YOUR_USERNAME/setup-git-semver.git + ``` + +3. **Create a branch**: + Create a new branch for your changes: + ```bash + git checkout -b feature-branch + ``` + +4. **Make your changes**: + Make your changes to the codebase. Ensure that you test your changes thoroughly and maintain existing functionality. + +5. **Commit your changes**: + Commit your changes with a clear and concise commit message. Follow the [Conventional Commit](https://www.conventionalcommits.org/) guidelines if possible. + ```bash + git commit -m "feat: added new feature to install specific version" + ``` + +6. **Push your changes**: + Push your changes to your forked repository: + ```bash + git push origin feature-branch + ``` + +7. **Create a Pull Request**: + Open a pull request (PR) from your feature branch to the `main` branch of the original repository. + +8. **Describe your changes**: + Provide a detailed description of the changes you made in the PR and link any relevant issues. + +### Code Style + +- Use [Prettier](https://prettier.io/) to format your code. +- Ensure that your code follows the conventions and structure of the existing codebase. + +### Testing + +Ensure that your changes do not break existing functionality. If possible, include tests for any new features or bug fixes. + +### Documentation + +If you make changes that affect how the action works or how it is used, please update the documentation (including the `README.md` and this `CONTRIBUTING.md`) to reflect the changes. + +## License + +By contributing to this project, you agree that your contributions will be licensed under the [Apache License 2.0](https://github.com/DJ-BBot/setup-git-semver?tab=Apache-2.0-1-ov-file#readme). + +## Code of Conduct + +By participating in this project, you agree to adhere to the project's [Code of Conduct](CODE_OF_CONDUCT.md). We strive to maintain a welcoming and respectful community for everyone. + +## Thank You! + +Your contributions are what make this project great. Thank you for helping improve `setup-git-semver`! + +--- + +**Author**: [Roger Barker](https://github.com/DJ-BBot) +**Email**: [pendletonroger@gmail.com](mailto:pendletonroger@gmail.com) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..54de626 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,54 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and maintainers of this project pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, inclusive, and healthy environment. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our project 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 attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email address, without their explicit permission +- Other conduct which could reasonably be considered inappropriate in a professional setting + +## Our Responsibilities + +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 with this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies within all project spaces, both physical and online, when an individual is representing the project or its community. Examples of representing a project or community include using an official project email address, posting via an official social media account, or acting as an appointed representative at an online or offline event. + +This Code of Conduct also applies outside project spaces when the individual is representing the project or its community in public spaces. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [your.email@example.com]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. Maintainers are obligated to maintain confidentiality with regard to the reporter of an incident. + +## Enforcement Guidelines + +Project maintainers will follow these Community Impact Guidelines in determining the consequences for any action they deem to be in violation of this Code of Conduct: + +- **Contribution Removal**: Violations of the Code of Conduct may result in a temporary or permanent ban on the ability to contribute to the project. +- **Warning**: The offending participant may be given a warning after the first instance of inappropriate behavior. +- **Temporary Ban**: If the inappropriate behavior continues, the participant may be temporarily banned from participating in the community for a period of time. +- **Permanent Ban**: In extreme cases, an individual may be permanently banned from contributing to the project. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. From afc4ca93184ff5d2de706a48c4e122e968d53206 Mon Sep 17 00:00:00 2001 From: Roger Barker Date: Thu, 16 Jan 2025 23:59:04 -0600 Subject: [PATCH 3/3] Moved CONTRIBUTING.md to root level Signed-off-by: Roger Barker --- .github/CONTRIBUTING.md => CONTRIBUTING.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/CONTRIBUTING.md => CONTRIBUTING.md (100%) diff --git a/.github/CONTRIBUTING.md b/CONTRIBUTING.md similarity index 100% rename from .github/CONTRIBUTING.md rename to CONTRIBUTING.md