Skip to content

Instantly share code, notes, and snippets.

@BackFront
Last active December 5, 2017 20:43
Show Gist options
  • Save BackFront/2741cb87a8e8e491abc587f3ab0aaccc to your computer and use it in GitHub Desktop.
Save BackFront/2741cb87a8e8e491abc587f3ab0aaccc to your computer and use it in GitHub Desktop.
Backfront Markdowns

Contributing

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
  4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Issues and labels

Our bug tracker utilizes several labels to help organize and identify issues. Here's what they represent and how we use them:

  • browser bug - Issues that are reported to us, but actually are the result of a browser-specific bug. These are diagnosed with reduced test cases and result in an issue opened on that browser's own bug tracker.
  • confirmed - Issues that have been confirmed with a reduced test case and identify a bug in Bootstrap.
  • css - Issues stemming from our compiled CSS or source Less/Sass files.
  • customizer - Issues with our web-based Customizer.
  • docs - Issues for improving or updating our documentation.
  • examples - Issues involving the example templates included in our docs.
  • feature - Issues asking for a new feature to be added, or an existing one to be extended or modified. New features require a minor version bump (e.g., v3.0.0 to v3.1.0).
  • grunt - Issues with our included JavaScript-based Gruntfile, which is used to run all our tests, concatenate and compile source files, and more.
  • help wanted - Issues we need or would love help from the community to resolve.
  • js - Issues stemming from our compiled or source JavaScript files.
  • meta - Issues with the project itself or our GitHub repository.

For a complete look at our labels, see the project labels page.

Feature requests

Feature requests are welcome, but please note that they must target Bootstrap v4, because Bootstrap v3 is now in maintenance mode and is closed off to new features. This is so that we can focus our efforts on Bootstrap v4, the future of the framework.

Before opening a feature request, please take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

Pull requests

Good pull requests—patches, improvements, new features—are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment