Skip to content

Latest commit

 

History

History
190 lines (136 loc) · 16.8 KB

CONTRIBUTING.md

File metadata and controls

190 lines (136 loc) · 16.8 KB
Raw

Contributing to Pressbooks

The following is a set of guidelines for contributing to Pressbooks (thanks to the Atom project for their excellent contributing guidelines, on which these are based). If you plan on opening issues or submitting pull requests, we ask that you first take a moment to familiarize yourself with it. Thanks for your interest! 📚

Table Of Contents

  1. Code of Conduct
  2. How To Contribute?
  3. Styleguides
  4. Additional Notes

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

How To Contribute

Installing for Development

Pressbooks uses Composer for dependency management and Webpack for asset compilation. The local development setup for Pressbooks is based on Bedrock and Trellis. If you are cloning this repository for local development, please read our local development guide.

Reporting Bugs

Before Submitting A Bug Report

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. Create an issue and provide the following information.

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • If the problem is related to exporting, attach (if possible) an export file which demonstrates the problem.

Provide more context by answering these questions:

  • Can you reproduce the problem with all other plugins deactivated?
  • Are you experiencing this issue with one of our built-in root or book themes, or with your own custom root or book theme?
  • Did the problem start happening recently (e.g. after updating to a new version of Pressbooks) or was this always a problem?
  • If the problem started happening recently, can you reproduce the problem in an older version of Pressbooks? What's the most recent version in which the problem doesn't happen? You can download older versions of Pressbooks on the releases page.
  • Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.

Include details about your configuration and environment:

  • Which versions of Pressbooks and WordPress are you using? You can get the version of Pressbooks from the readme.txt file in the Pressbooks plugin (usually located at http://<yourdomain.tld>/wp-content/plugins/pressbooks/readme.txt) and the version of WordPress from the readme.html file in the WordPress root directory (usually located at http://<yourdomain.tld>/readme.html).
  • Which root and/or book theme(s) are you using?
  • What server software (e.g. Apache, Nginx) and PHP version are being used to host your Pressbooks instance? You can usually get your PHP version from your web host, or by using the phpversion() function.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Pressbooks, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.

Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible.

Before Submitting An Enhancement Suggestion

  • Perform a search for Pressbooks-specific WordPress plugins. Your feature may already be available in one of these.
  • Perform a search for general-purpose WordPress plugins. Your feature may already be available in one of these.
  • Perform a cursory search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. Create an issue and provide the following information:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Explain why this enhancement would be useful to most Pressbooks users and isn't something that can or should be implemented as a standalone plugin.
  • Specify which versions of Pressbooks and WordPress you're using. You can get the version of Pressbooks from the readme.txt file in the Pressbooks plugin (usually located at http://<yourdomain.tld>/wp-content/plugins/pressbooks/readme.txt) and the version of WordPress from the readme.html file in the WordPress root directory (usually located at http://<yourdomain.tld>/readme.html).
  • Specify which root and/or book theme(s) you're using.

Your First Code Contribution

If you'd like to get involved, we suggest you take a look at beginner or help-wanted issues:

  • Beginner issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than beginner issues.

Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.

Pull Requests

  • Where relevant, please include screenshots in your pull request.
  • Please follow our Code Styleguide in writing your new code.
  • Please document your new code as stipulated in our Documentation Styleguide.

NB: We are making an effort to expand unit testing in Pressbooks. As such, we ask that any pull requests that add new functions include corresponding tests for those functions. If you submit a pull request which does not do this, you will be asked to revise the pull requests to add tests.

Styleguides

We are in the process of creating comprehensive style guides for code, documentation and Git commit messages.

Code Styleguide

Our code styleguide can be found here.

Documentation Styleguide

Documentation of PHP functions should adhere to the PHPDoc format.

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally.
  • When only changing documentation, include [ci skip] in the commit description to avoid running automated tests.

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

GitHub search makes it easy to use labels for finding groups of issues or pull requests you're interested in. For example, you might be interested in open issues across pressbooks/pressbooks which are labeled as bugs, but still need to be reliably reproduced or perhaps open pull requests in pressbooks/pressbooks which haven't been reviewed yet. To help you find issues and pull requests, each label is listed with search links for finding open items with that label in pressbooks/pressbooks. We encourage you to read about other search filters which will help you write more focused queries.

The labels are loosely grouped by their purpose, but it's not required that every issue have a label from every group or that an issue can't have more than one label from the same group.

Please open an issue on pressbooks/pressbooks if you have suggestions for new labels.

Type of Issue and Issue State

Label name pressbooks/pressbooks Description
enhancement search Feature requests.
bug search Confirmed bugs or reports that are very likely to be bugs.
a11y search Accessibility-related bug reports or feature requests.
priority search Issues which the Pressbooks team has identified as priorities.
question search Questions more than bug reports or feature requests (e.g. how do I do X).
feedback search General feedback more than bug reports or feature requests.
help-wanted search The Pressbooks team would appreciate help from the community in resolving these issues.
beginner search Less complex issues which would be good first issues to work on for users who want to contribute to Pressbooks.
more-information-needed search More information needs to be collected about these problems or feature requests (e.g. steps to reproduce).
needs-reproduction search Likely bugs, but haven't been reliably reproduced.
blocked search Issues blocked on other issues.
duplicate search Issues which are duplicates of other issues, i.e. they have been reported before.
wontfix search The Pressbooks team has decided not to fix these issues for now, either because they're working as intended or for some other reason.
invalid search Issues which aren't valid (e.g. user errors).

Pull Request Labels

| Label name | pressbooks/pressbooks | Description | | --- | --- | --- | --- | | work-in-progress | search | Pull requests which are still being worked on, more changes will follow. | | needs-review | search | Pull requests which need code review, and approval from maintainers or the Pressbooks team. | | under-review | search | Pull requests being reviewed by maintainers or the Pressbooks team. | | requires-changes | search | Pull requests which need to be updated based on review comments and then reviewed again. | | needs-testing | search | Pull requests which need manual testing. |