Skip to content
This repository was archived by the owner on May 13, 2024. It is now read-only.

Commit 776bd74

Browse files
keithrfungechumley-msft
authored andcommitted
📝 Update Contributing document
1 parent e00dfa5 commit 776bd74

1 file changed

Lines changed: 28 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,31 @@
11
# Contributing
22

3+
* [Getting Started](#getting-started)
4+
* [Pull Requests](#pull-requests)
5+
* [Contributor License Agreement](#contributor-license-agreement)
6+
* [Code of Conduct](#code-of-conduct)
7+
* [Developer's Certificate of Origin 1.1](#developers-certificate-of-origin)
8+
9+
10+
## Getting Started
11+
12+
If new to the project,
13+
1. Review the [Technical Specification](https://github.com/microsoft/ElectionGuard-SDK-Specification)
14+
2. Install according to [ReadMe](./README.rst)
15+
OR
16+
refer to [Documentation](https://electionguard.github.io/ElectionGuard-SDK-C-Documentation/)
17+
3. Once you're up and running, be sure to run the simple election test
18+
19+
⚠ Note: If you get stuck, take a look at our [GitHub Action](./.github/workflows/pr-workflow.yml)
20+
21+
## Pull Requests
22+
23+
Before submitting a pull request, [rebase](https://www.atlassian.com/git/tutorials/merging-vs-rebasing) your branch from master. Do not use ``git merge`` or the *merge* button provided by Github.
24+
25+
Ensure your pull request is [referencing at least one issue](https://help.github.com/en/github/managing-your-work-on-github/closing-issues-using-keywords) and following PR template.
26+
27+
## [Contributor License Agreement](https://cla.opensource.microsoft.com)
28+
329
This project welcomes contributions and suggestions. Most contributions require you to agree to a
430
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
531
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
@@ -8,11 +34,12 @@ When you submit a pull request, a CLA bot will automatically determine whether y
834
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
935
provided by the bot. You will only need to do this once across all repos using our CLA.
1036

37+
## [Code of Conduct](CODE_OF_CONDUCT.md)
38+
1139
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
1240
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
1341
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
1442

15-
<a id="developers-certificate-of-origin"></a>
1643
## Developer's Certificate of Origin 1.1
1744

1845
By making a contribution to this project, I certify that:

0 commit comments

Comments
 (0)