Skip to content

Latest commit

 

History

History
65 lines (45 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

65 lines (45 loc) · 2.33 KB
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Development environment setup

To set up a development environment, please follow these steps:

  1. Clone the repo

    ~$ git clone https://github.com/orkim/gpg-book

  2. Create a virtual environment and install the required dependencies

    ~/gpg-book$ cd gpg-book
~/gpg-book$ virtualenv venv
~/gpg-book$ source venv/bin/activate
(venv) ~/gpg-book$ pip install sphinx sphinx-book-theme myst-parser

  3. Now build the documentation locally

    (venv) ~/gpg-book$ make html

  4. Open ~/gpg-book/build/html/index.html to review changes made

Development notes

  • All Markdown source files for the book is located in the ~/gpg-book/sources subdirectory. Development will most likely be focused here for content within the book.

  • The ~/gpg-book/docs/ folder is reserved for the source repository documentation.

Issues and feature requests

You've found a bug in the examples, a mistake in the documentation, or maybe you'd like a new feature? You can help us by submitting an issue on GitHub. Before you create an issue, make sure to search the issue archive -- your issue may have already been addressed!

Please try to create bug reports that are:

  • Specific. Include as much detail as possible: which version, what environment, etc.
  • Unique. Do not duplicate existing opened issues.
  • Scoped to a Single Bug. One bug per report.

Even better: Submit a pull request with a fix or new feature!

How to submit a Pull Request

  1. Search our repository for open or closed Pull Requests that relate to your submission. You don't want to duplicate effort.
  2. Fork the project
  3. Create your feature branch (git checkout -b feat/amazing_feature)
  4. Commit your changes (git commit -m 'feat: add amazing_feature') The GnuPG Book Project uses conventional commits, so please follow the specification in your commit messages.
  5. Push to the branch (git push origin feat/amazing_feature)
  6. Open a Pull Request