diff --git a/.gitmodules b/.gitmodules index 1f5b89955..6da1408ba 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,3 @@ [submodule "mapistub"] path = mapistub - url = https://github.com/stephenegriffin/MAPIStubLibrary.git + url = https://github.com/microsoft/MAPIStubLibrary.git diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b5c508d07..1f77f662d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,25 +1,32 @@ # CONTRIBUTING + All pull requests are welcome, there are just a few guidelines you need to follow. -When contributing to this repository, please first discuss the change by creating a new [issue](https://github.com/stephenegriffin/mfcmapi/issues) or by replying to an existing one. +When contributing to this repository, please first discuss the change by creating a new [issue](https://github.com/microsoft/mfcmapi/issues) or by replying to an existing one. + +## GETTING STARTED -# GETTING STARTED -* Make sure you have a [GitHub account](https://github.com/signup/free). -* Fork the repository, you can [learn about forking on Github](https://help.github.com/articles/fork-a-repo) -* [Clone the repro to your local machine](https://help.github.com/articles/cloning-a-repository/). +* Make sure you have a [GitHub account](https://github.com/signup/free). +* Fork the repository, you can [learn about forking on Github](https://help.github.com/articles/fork-a-repo) +* [Clone the repro to your local machine](https://help.github.com/articles/cloning-a-repository/) like so: +```git clone --recursive https://github.com/microsoft/mfcmapi.git``` ## MAKING CHANGES -* Create branch topic for the work you will do, this is where you want to base your work. - * This is usually the main branch. - * To quickly create a topic branch based on main, run git checkout -b fix/main/my_contribution main. - * Note: Please avoid working directly on the main branch. -* Once you have a branch, make your changes and commit them to the local branch. + +* Create branch topic for the work you will do, this is where you want to base your work. +* This is usually the main branch. +* To quickly create a topic branch based on main, run +```git checkout -b u/username/topic main``` + * *Make sure to substitute your own name and topic in this command* * +* Once you have a branch, make your changes and commit them to the local branch. * All submissions require a review and pull requests are how those happen. Consult [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more information on pull requests. ## SUBMITTING CHANGES -* Push your changes to a topic branch in your fork of the repository. -## PUSH TO YOUR FORK AND SUBMIT A PULL REQUEST. +* Push your changes to a topic branch in your fork of the repository. + +## PUSH TO YOUR FORK AND SUBMIT A PULL REQUEST + At this point you're waiting on the code/changes to be reviewed. diff --git a/README.md b/README.md index b4cb67606..1cc3539ed 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,27 @@ # mfcmapi + MFCMAPI provides access to MAPI stores to facilitate investigation of Exchange and Outlook issues and to provide developers with a sample for MAPI development. -[Latest release](https://github.com/stephenegriffin/mfcmapi/releases/latest) -[Release stats (raw JSON)](https://api.github.com/repos/stephenegriffin/mfcmapi/releases/latest) -[Pretty release stats](https://somsubhra.github.io/github-release-stats/?username=stephenegriffin&repository=mfcmapi&page=1&per_page=5) +[Latest release](https://github.com/microsoft/mfcmapi/releases/latest) +[Release stats (raw JSON)](https://api.github.com/repos/microsoft/mfcmapi/releases/latest) +[Pretty release stats](https://somsubhra.github.io/github-release-stats/?username=microsoft&repository=mfcmapi&page=1&per_page=5) + +## Contributing + +MFCMAPI depends on the [MAPI Stub Library](https://github.com/microsoft/MAPIStubLibrary). When cloning, make sure to clone submodules. See [Contributing](CONTRIBUTING.md) for more details. -# Help/Feedback -For assistance using MFCMAPI, developing add-ins, or general MAPI development, consult the [documentation](docs/Documentation.md). Find a bug? Need help? Have a suggestion? Report your issues through the [issues tab](https://github.com/microsoft/mfcmapi/issues). +## Help/Feedback -# Become a fan on Facebook! -Facebook Badge +For assistance using MFCMAPI, developing add-ins, or general MAPI development, consult the [documentation](docs/Documentation.md). Find a bug? Need help? Have a suggestion? Report your issues through the [issues tab](https://github.com/microsoft/mfcmapi/issues). -Interested in Exchange Web Services (EWS)? Try [EWSEditor](https://github.com/dseph/EwsEditor)! +## Badges -Badges: -[![Release](https://dev.azure.com/mrmapi/MFCMAPI/_apis/build/status/Release/MFCMAPI%20Build?branchName=main)](https://dev.azure.com/mrmapi/MFCMAPI/_build/latest?definitionId=13&branchName=main) -[![continuous-integration](https://github.com/stephenegriffin/mfcmapi/actions/workflows/github-ci.yml/badge.svg)](https://github.com/stephenegriffin/mfcmapi/actions/workflows/github-ci.yml) -[![CodeQL](https://github.com/stephenegriffin/mfcmapi/actions/workflows/codeql.yml/badge.svg)](https://github.com/stephenegriffin/mfcmapi/actions/workflows/codeql.yml) -[![Clang-format](https://github.com/microsoft/mfcmapi/actions/workflows/clang.yml/badge.svg)](https://github.com/stephenegriffin/mfcmapi/actions/workflows/clang.yml) -[![Dependency Review](https://github.com/stephenegriffin/mfcmapi/actions/workflows/dependency-review.yml/badge.svg)](https://github.com/stephenegriffin/mfcmapi/actions/workflows/dependency-review.yml) +[![continuous-integration](https://github.com/microsoft/mfcmapi/actions/workflows/github-ci.yml/badge.svg)](https://github.com/microsoft/mfcmapi/actions/workflows/github-ci.yml) +[![Clang-format](https://github.com/microsoft/mfcmapi/actions/workflows/clang.yml/badge.svg)](https://github.com/microsoft/mfcmapi/actions/workflows/clang.yml) +[![CodeQL](https://github.com/microsoft/mfcmapi/actions/workflows/codeql.yml/badge.svg)](https://github.com/microsoft/mfcmapi/actions/workflows/codeql.yml) +[![Dependency Review](https://github.com/microsoft/mfcmapi/actions/workflows/dependency-review.yml/badge.svg)](https://github.com/microsoft/mfcmapi/actions/workflows/dependency-review.yml) +[![DevSkim](https://github.com/microsoft/mfcmapi/actions/workflows/devskim.yml/badge.svg)](https://github.com/microsoft/mfcmapi/actions/workflows/devskim.yml) [![OpenSSF -Scorecard](https://api.securityscorecards.dev/projects/github.com/stephenegriffin/mfcmapi/badge)](https://api.securityscorecards.dev/projects/github.com/stephenegriffin/mfcmapi) -[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7901/badge)](https://www.bestpractices.dev/projects/7901) +Scorecard](https://api.securityscorecards.dev/projects/github.com/microsoft/mfcmapi/badge)](https://api.securityscorecards.dev/projects/github.com/microsoft/mfcmapi) +[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7901/badge)](https://www.bestpractices.dev/projects/7901) +[![Facebook](https://badge.facebook.com/badge/26764016480.2776.1538253884.png)](https://www.facebook.com/MFCMAPI) \ No newline at end of file diff --git a/SECURITY.md b/SECURITY.md index b3c89efc8..167c4b408 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -14,17 +14,17 @@ Instead, please report them to the Microsoft Security Response Center (MSRC) at If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/security.md/msrc/pgp). -You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). +You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: - * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.) - * Full paths of source file(s) related to the manifestation of the issue - * The location of the affected source code (tag/branch/commit or direct URL) - * Any special configuration required to reproduce the issue - * Step-by-step instructions to reproduce the issue - * Proof-of-concept or exploit code (if possible) - * Impact of the issue, including how an attacker might exploit the issue +* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.) +* Full paths of source file(s) related to the manifestation of the issue +* The location of the affected source code (tag/branch/commit or direct URL) +* Any special configuration required to reproduce the issue +* Step-by-step instructions to reproduce the issue +* Proof-of-concept or exploit code (if possible) +* Impact of the issue, including how an attacker might exploit the issue This information will help us triage your report more quickly. diff --git a/_includes/page-footer.html b/_includes/page-footer.html index 949c14eef..6f43c7f69 100644 --- a/_includes/page-footer.html +++ b/_includes/page-footer.html @@ -1,6 +1,6 @@