From a90f8846c1d3a6cad378432e9d11827dc2f2732c Mon Sep 17 00:00:00 2001 From: Connor Mulligan Date: Mon, 16 Sep 2024 13:20:23 -0700 Subject: [PATCH 1/3] docs: add contributors doc --- CONTRIBUTING | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 CONTRIBUTING diff --git a/CONTRIBUTING b/CONTRIBUTING new file mode 100644 index 0000000..8a3f9b2 --- /dev/null +++ b/CONTRIBUTING @@ -0,0 +1,49 @@ +# Contributing to the Backstage Dora Plugin + +Thank you for considering contributing to the Backstage Dora Plugin! We're excited to have you on board. + +## Code of Conduct + +We follow the standard open-source code of conduct. Please be respectful and considerate in your interactions with the community. + +## Getting Started + +Before you start contributing, please make sure you have the following: + +* Node.js +* npm or yarn +* A code editor or IDE of your choice + +## Coding Style and Practices + +We follow standard JavaScript and React coding practices. Please make sure to: + +* Use consistent indentation and spacing. +* Use clear and descriptive variable names. +* Use functions and modules to organize your code. +* Keep your code concise and readable. +* Use JSDoc comments to document your code. + +### Using `pre-commit` + +We use [pre-commit](https://pre-commit.com/) to ensure that our code is formatted consistently and follows good coding practices. Run `pre-commit install` to install the pre-commit hooks. After installation, `pre-commit` will run automatically against your changes on every commit. You can also run `pre-commit run --all-files` to manually run the hooks on all files. + +## Testing + +We use Jest for testing. Please make sure to write tests for any new features or bug fixes you contribute. + +## Opening Pull Requests + +To contribute to the codebase, please follow these steps: + +1. Fork the repository and create a new branch for your feature or bug fix. +2. Run `npm install` or `yarn install` to install the dependencies. +3. Run `pre-commit install` to install the pre-commit hooks. +4. Use [Conventional Commits](https://www.conventionalcommits.org) to format your commit messages. +5. Open a pull request to the main repository, targeting the `main` branch. + +## Review Process + +Once you've opened a pull request, it will be reviewed by the maintainers. We'll provide feedback and guidance to help you improve your contribution. + +Thank you again for contributing to the Backstage Dora Plugin! From 6f58ca06c46d59d41ed9025303d44982434f33bc Mon Sep 17 00:00:00 2001 From: Connor Mulligan Date: Mon, 16 Sep 2024 14:46:37 -0700 Subject: [PATCH 2/3] docs: update readme to point to contributing doc --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 8998466..1ebe475 100644 --- a/README.md +++ b/README.md @@ -220,3 +220,7 @@ To Install this plugin you'll need to do the following: - elite: 1 (1 hr or less) - high: 24 (1 day or less) - medium: 168 (1 week or less) + +# Contributing + +See [Contributing](./CONTRIBUTING) to Backstage Dora Plugin \ No newline at end of file From 2a6b7a71c20922ea3c9fafd5b3a0aa4d8ba46861 Mon Sep 17 00:00:00 2001 From: Casey Wilson Date: Tue, 17 Sep 2024 09:58:52 -0400 Subject: [PATCH 3/3] chore: ran prettier:fix --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1ebe475..04cac9b 100644 --- a/README.md +++ b/README.md @@ -221,6 +221,6 @@ To Install this plugin you'll need to do the following: - high: 24 (1 day or less) - medium: 168 (1 week or less) -# Contributing +# Contributing -See [Contributing](./CONTRIBUTING) to Backstage Dora Plugin \ No newline at end of file +See [Contributing](./CONTRIBUTING) to Backstage Dora Plugin