Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: updates to markdown files to match updated pepr-docs structure #804

Merged
merged 1 commit into from
May 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/030_user-guide/020_pepr-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,3 @@
## What is a Pepr Module?

A Pepr Module is a collection of files that can be used to create a new Pepr Project. A Pepr Module can be used to create a new Pepr Project by using the `npx pepr init` command.

16 changes: 0 additions & 16 deletions docs/100_community/010_support.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/100_community/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ You can find all the details on contributing to Pepr at:

Information on reporting bugs can be found at:

* [Reporting Bugs](010_support.md#reporting-bugs)
* [Reporting Bugs](../../SUPPORT.md)

### Reporting Security Issues

Information on reporting security issues can be found at:

* [Reporting Security Issues](../120_contribute/040_report-security-issue.md)
* [Reporting Security Issues](../../SECURITY.md)
73 changes: 0 additions & 73 deletions docs/120_contribute/010_contributor-guide.md

This file was deleted.

81 changes: 0 additions & 81 deletions docs/120_contribute/020_code-of-conduct.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/120_contribute/040_report-security-issue.md

This file was deleted.

74 changes: 65 additions & 9 deletions docs/120_contribute/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,73 @@
# Contribute to Pepr
# Contributor Guide

Pepr is an open source project and we welcome contributions of all kinds. There are many ways to contribute, from improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into Pepr itself.
Thank you for your interest in contributing to Pepr! We welcome all contributions and are grateful for your help. This guide outlines how to get started with contributing to this project.

Information in this section includes:
## Table of Contents

## Contributor Guide

If you are interested in contributing to Pepr, please read our [Contributor Guide](010_contributor-guide.md) to learn more about how to get started.
- [Contributor Guide](#contributor-guide)
- [Table of Contents](#table-of-contents)
- [Code of Conduct](#code-of-conduct)
- [Getting Started](#getting-started)
- [Setup](#setup)
- [Submitting a Pull Request](#submitting-a-pull-request)
- [PR Requirements](#pr-requirements)
- [Coding Guidelines](#coding-guidelines)
- [Running Tests](#running-tests)
- [Run Tests Locally](#run-tests-locally)
- [Test a Local Development Version](#test-a-local-development-version)
- [Contact](#contact)

## Code of Conduct

Please note that this project is released with a [Contributor Code of Conduct](020_code-of-conduct.md). By participating in this project you agree to abide by its terms.
Please follow our [Code of Conduct](../../CODE_OF_CONDUCT.md) to maintain a respectful and collaborative environment.

## Getting Started

- **Repository**: [https://github.com/defenseunicorns/pepr/](https://github.com/defenseunicorns/pepr/)
- **npm package**: [https://www.npmjs.com/package/pepr](https://www.npmjs.com/package/pepr)
- **Required Node version**: `>=18.0.0`

### Setup

1. Fork the repository.
2. Clone your fork locally: `git clone https://github.com/your-username/pepr.git`.
3. Install dependencies: `npm ci`.
4. Create a new branch for your feature or fix: `git checkout -b my-feature-branch`.

## Submitting a Pull Request

1. **Create an Issue**: For significant changes, please create an issue first, describing the problem or feature proposal. Trivial fixes do not require an issue.
2. **Commit Your Changes**: Make your changes and commit them. All commits must be signed.
3. **Run Tests**: Ensure that your changes pass all tests by running `npm test`.
4. **Push Your Branch**: Push your branch to your fork on GitHub.
5. **Create a Pull Request**: Open a pull request against the `main` branch of the Pepr repository. Please make sure that your PR passes all CI checks.

### PR Requirements

- PRs must be against the `main` branch.
- PRs must pass CI checks.
- All commits must be signed.
- PRs should have a related issue, except for trivial fixes.

## Coding Guidelines

Please follow the coding conventions and style used in the project. Use ESLint and Prettier for linting and formatting:

- Check formatting: `npm run format:check`
- Fix formatting: `npm run format:fix`

## Running Tests

### Run Tests Locally

- Run all tests: `npm test`

### Test a Local Development Version

1. Run `npm test` and wait for completion.
2. Change to the test module directory: `cd pepr-test-module`.
3. You can now run any of the `npx pepr` commands.

## Reporting Security Issues
## Contact

For information on reporting security issues, please see our [Reporting Security Issues](040_report-security-issue.md).
For any questions or concerns, please open an issue on GitHub or contact the maintainers.
Loading