Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
L
lagoproject.net
Manage
Activity
Members
Plan
Wiki
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Terraform modules
Analyze
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
LAGO
lagoproject.net
Commits
46474cc7
Commit
46474cc7
authored
8 years ago
by
squidfunk
Browse files
Options
Downloads
Patches
Plain Diff
Update contribution guidelines for GitHub
parent
efff866b
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
CONTRIBUTING.md
+27
-12
27 additions, 12 deletions
CONTRIBUTING.md
with
27 additions
and
12 deletions
CONTRIBUTING.md
+
27
−
12
View file @
46474cc7
# Contributing
# Contributing
Interested in contributing to the Material theme?
Before you do, please read
Interested in contributing to the Material theme?
Want to report a bug? Before
the following guidelines.
you do, please read
the following guidelines.
## Submission context
## Submission context
...
@@ -15,8 +15,12 @@ For quick questions there's no need to open an issue as you can reach us on
...
@@ -15,8 +15,12 @@ For quick questions there's no need to open an issue as you can reach us on
### Found a bug?
### Found a bug?
If you found a bug in the source code, you can help us by submitting an issue
If you found a bug in the source code, you can help us by submitting an issue
to our GitHub Repository. Even better, you can submit a Pull Request with a
to the
[
issue tracker
][
2
]
in our GitHub repository. Even better, you can submit
fix. However, before doing so, read the submission guidelines.
a Pull Request with a fix. However, before doing so, please read the
[
submission guidelines
][
3
]
.
[
2
]:
https://github.com/squidfunk/mkdocs-material/issues
[
3
]:
#submission-guidelines
### Missing a feature?
### Missing a feature?
...
@@ -47,20 +51,31 @@ readily available.
...
@@ -47,20 +51,31 @@ readily available.
We want to fix all the issues as soon as possible, but before fixing a bug we
We want to fix all the issues as soon as possible, but before fixing a bug we
need to reproduce and confirm it. In order to reproduce bugs we will
need to reproduce and confirm it. In order to reproduce bugs we will
systematically ask you to provide a minimal reproduction scenario using the
systematically ask you to provide a minimal reproduction scenario using the
custom issue template.
custom issue template.
Please stick to the issue template.
Unfortunately we are not able to investigate / fix bugs without a minimal
Unfortunately we are not able to investigate / fix bugs without a minimal
reproduction, so if we don't hear back from you we are going to close issues
reproduction scenario, so if we don't hear back from you we may close the issue.
that don't have enough information to be reproduced.
### Submitting a Pull Request (PR)
### Submitting a Pull Request (PR)
Search GitHub for an open or closed PR that relates to your submission. You
Search GitHub for an open or closed PR that relates to your submission. You
don't want to duplicate effort. Fork the project, make your changes in
**
a new
don't want to duplicate effort. If you do not find a related issue or PR,
git branch
**
and commit your changes with a descriptive commit message. Then
go ahead.
push your branch to GitHub and send a PR to
`mkdocs-material:master`
. If we
suggest changes, make the required updates, rebase your branch and push
1.
**Development**
: Fork the project, set up the
[
development environment
][
4
]
,
the changes to your GitHub repository, which will automatiaclly update your PR.
make your changes in a separate git branch and add descriptive messages to
your commits.
2.
**Build**
: Before submitting a pull requests, build the theme. This is a
mandatory requirement for your PR to get accepted, as the theme should at
all times be installable through GitHub.
3.
**Pull Request**
: After building the theme, commit the compiled output, push
your branch to GitHub and send a PR to
`mkdocs-material:master`
. If we
suggest changes, make the required updates, rebase your branch and push the
changes to your GitHub repository, which will automatically update your PR.
After your PR is merged, you can safely delete your branch and pull the changes
After your PR is merged, you can safely delete your branch and pull the changes
from the main (upstream) repository.
from the main (upstream) repository.
[
4
]:
http://localhost:8000/customization/#theme-development
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment