Thank you for considering making a contribution to this project! We sincerely appreciate your time and energy invested in getting to know this project's code. We are also appreciative that you've taken time to read this guideline and cared enough to contriubute.
The following is a set of guidelines for contributing to the Marathon Autoscaler project. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.
What should I know before I get started?
This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
Before creating bug reports, please perform a cursory search** to see if the problem has already been reported. If it has, add a comment to the existing issue instead of opening a new one. When you are creating a bug report, please include as many details as possible. If you'd like, you can use this template to structure the information.
Bugs are tracked as GitHub issues.
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. When listing steps, don't just say what you did, but explain how you did it.
-
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.
-
Include the Autoscaler's logging output. Copy the pertinent snippet of log information from the Autoscaler's standard out. If the log output is too long, please open a public Gist and include the link to this Gist with your report. Provide more context by answering these questions:
-
Did the problem start happening recently (e.g. after updating to a new version) or was this always a problem?
-
If the problem started happening recently, can you reproduce the problem in an older version of Autoscaler? What's the most recent version in which the problem doesn't happen?
-
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 Marathon and Mesos are you using?
- What's the name(s) and version(s) of the OS(es) you're running?
- Are you running the Autoscaler in Docker Machine locally or on Mesos/Marathon?
- Other configuration information that you believe to be relevant
This section guides you through submitting an enhancement suggestion for Autoscaler, 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. If you'd like, you can use this template to structure the information.
- 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.
Enhancement suggestions are tracked as GitHub issues. 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.
[Short description of suggestion]
**Steps which explain the enhancement**
1. [First Step]
2. [Second Step]
3. [Other Steps...]
**Current and suggested behavior**
[Describe current and suggested behavior here]
**Why would the enhancement be useful to most users**
[Explain why the enhancement would be useful to most users]
Unsure where to begin contributing to Autoscaler? You can start by looking through these beginner and help-wanted issues:
- Beginner issues - issues which should only require a few lines of code, and a test or two.
- [Help wanted issues][help-wanted] - issues which should be a bit more involved than
beginnerissues.
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.
- Reference the Github Issue
- Document new code based on the Documentation Styleguide
- End files with a newline.
- 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 - Consider starting the commit message with an applicable emoji:
- 🎨
:art:when improving the format/structure of the code - 🐎
:racehorse:when improving performance - 🚱
:non-potable_water:when plugging memory leaks - 📝
:memo:when writing docs - 🐧
:penguin:when fixing something on Linux - 🍎
:apple:when fixing something on Mac OS - 🏁
:checkered_flag:when fixing something on Windows - 🐛
:bug:when fixing a bug - 🔥
:fire:when removing code or files - 💚
:green_heart:when fixing the CI build - ✅
:white_check_mark:when adding tests - 🔒
:lock:when dealing with security - ⬆️
:arrow_up:when upgrading dependencies - ⬇️
:arrow_down:when downgrading dependencies - 👕
:shirt:when removing linter warnings
- 🎨
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. To help you find issues and pull requests, each label is listed with search links for finding open items with that label. 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 if you have suggestions for new labels, and if you notice some labels are missing on some repositories, then please open an issue on that repository.
| Label name | 🔎 | Description |
|---|---|---|
enhancement |
search | Feature requests. |
bug |
search | Confirmed bugs or reports that are very likely to be bugs. |
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 core 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 Marathon Autoscaler. |
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 core 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). |
| Label name | 🔎 | Description |
|---|---|---|
documentation |
search | Related to any type of documentation. |
performance |
search | Related to performance. |
security |
search | Related to security. |
api |
search | Related to APIs. |
uncaught-exception |
search | Issues about uncaught exceptions. |
crash |
search | Reports of crashing. |
network |
search | Related to network problems or working with remote files (e.g. on network drives). |
git |
search | Related to Git functionality (e.g. problems with gitignore files or with showing the correct file status). |
build-error |
search | Related to problems with building from source. |
| Label name | 🔎 | 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 core team. |
under-review |
search | Pull requests being reviewed by maintainers or core 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. |
[help-wanted]:https://github.com/issues?q=is%3Aopen+is%3Aissue+label%3Ahelp-wanted+repo%3Atendrilinc%2Fmarathon-autoscale+sort%3Acomments-desc).
- Use Markdown.