Skip to content

Commit 5ea8de1

Browse files
committed
Update CONTRIBUTING.md for clarity and structure
Refine the development and testing instructions for better understanding. Enhance the formatting of sections and emphasize important guidelines for contributors. Thank you!
1 parent bcd4afe commit 5ea8de1

1 file changed

Lines changed: 17 additions & 17 deletions

File tree

CONTRIBUTING.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ for being here and looking into how you can help!
1111
- bugs TODO: link to issues issue template
1212
- communicate via issues, PRs, and discussions as well as the project
1313

14-
### Develop & Build
14+
## Develop & Build
1515

1616
We are using the [Sampler](https://github.com/gaelcolas/Sampler) Powershell Module to structure our module. This makes it easier to develop and test the module locally.
1717

@@ -53,15 +53,15 @@ The workflow for using this and developing the code is shown below.
5353

5454
4. Use GitHub CoPilot to write your commit messages by clicking on the sparkles in the commit message box. This will generate a commit message based on the changes you made. You can then edit the message to make it more descriptive if you want. This uses the prompt in the `.github\copilot-commit-message-instructions.md` file.
5555

56-
Add this to your VS Code settings to enable it:
56+
Add this to your VS Code settings to enable it:
5757

58-
```json
59-
"github.copilot.chat.commitMessageGeneration.instructions": [
60-
{
61-
"file": ".github/copilot-commit-message-instructions.md"
62-
}
63-
],
64-
```
58+
```json
59+
"github.copilot.chat.commitMessageGeneration.instructions": [
60+
{
61+
"file": ".github/copilot-commit-message-instructions.md"
62+
}
63+
],
64+
```
6565

6666
5. Build the module. From the root of the repository run the following command:
6767

@@ -71,15 +71,13 @@ Add this to your VS Code settings to enable it:
7171

7272
This will build the module and create a new folder in the root of the repository called `output`. It will also load the new module into your current session.
7373

74-
6. AFTER building, you can then run the Pester tests to ensure that everything is working as expected. The tests are located in the `tests` folder and can be run using the following command:
74+
6. **AFTER** building, you can then run the Pester tests to ensure that everything is working as expected. The tests are located in the `tests` folder and can be run using the following command:
7575

7676
```PowerShell
7777
Invoke-Pester ./tests/
7878
```
7979

80-
This will run all the tests in the `tests` folder and output the results to the console.
81-
82-
You can also run specific tags such as `FunctionalQuality`, `TestQuality`, `HelpQuality`.
80+
This will run all the tests in the `tests` folder and output the results to the console. You can also run specific tags such as `FunctionalQuality`, `TestQuality`, `HelpQuality`.
8381

8482
7. You can also simulate the deployment testing by running the following command:
8583

@@ -89,7 +87,7 @@ Add this to your VS Code settings to enable it:
8987

9088
8. Once you are happy with your code, push your branch to GitHub and create a PR against the repo.
9189

92-
# Thanks!
90+
## Thanks!
9391

9492
We will review your PR and get back to you as soon as we can. We are all volunteers and do this in our spare time, so please be patient with us. We will try to get back to you within a week, but it may take longer if we are busy.
9593

@@ -100,12 +98,12 @@ If you have any questions or need help, please feel free to reach out to us on t
10098
TODO:
10199
Pull Request protocol etc. You might also include what response they'll get back from the team on submission, or any caveats about the speed of response.
102100

103-
## How to report a bug:
101+
## How to report a bug
104102

105103
TODO:
106104
Bugs are problems in code, in the functionality of an application or in its UI design; you can submit them through "bug trackers" and most projects invite you to do so, so that they may "debug" with more efficiency and the input of a contributor. Take a look at Atom's example for how to teach people to report bugs to your project.
107105

108-
## Templates:
106+
## Templates
109107

110108
TODO:
111109
in this section of your file, you might also want to link to a bug report "template" like this one here which contributors can copy and add context to; this will keep your bugs tidy and relevant.
@@ -121,6 +119,8 @@ TODO: maybe beef this out - stolen from data sat repo for now.
121119

122120
We expect and demand that you follow some basic rules. Nothing dramatic here. There will be a proper code of conduct for the websites added soon, but in this repository
123121

124-
BE EXCELLENT TO EACH OTHER
122+
| :heavy_exclamation_mark: **Important** |
123+
| :------------------------------------- |
124+
| **BE EXCELLENT TO EACH OTHER** |
125125

126126
Do I need to say more? If your behaviour or communication does not fit into this statement, we do not wish for you to help us.

0 commit comments

Comments
 (0)