👍🎉 First off, thanks for considering to contribute! 🎉👍
The following is a set of guidelines for contributing to Project Moore. 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?
Project Moore is a project started by UTN. You free to use, improve and distribute our code. We do ask that you publish your respective code. Furthermore, UTN board and management team decides the direction of the project. These decisions are upheld by the UTN system administrator. In any dispute their decision is final, but you're free to debate your case.
This section guides you through submitting a bug report for Project Moore. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻, and find related reports 🔎.
Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.
- Clear your cache to ensure the problem isn't caused by old files in your browser.
- 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.
Bugs are tracked as GitHub issues. After you've found a new bug, create an issue following information by filling in the template.
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. For example, start by explaining how opened the page, e.g. which program/browser you used.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem if possible. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
- If the problem is related to performance, include a performance profile, available in all major browsers.
- If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.
Provide more context by answering these questions:
- Did the problem start happening recently or was this always a problem?
- Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
- What's the name and version of the OS you're using?
This section guides you through submitting an enhancement suggestion for Project Moore, including completely new features and minor improvements to existing functionality. Following these guidelines helps us to understand your suggestion :pencil: and find related suggestions :mag_right:.
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. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.
- 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. 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.
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of Project Moore which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
- Explain why this enhancement would be useful.
- List some other websites or applications where this enhancement exists.
Unsure where to begin contributing to Project Moore? You can start by looking
through the help-wanted issues. Help wanted issues are issues
that don't require a full understanding of Project Moore or the Django
framework, but can guide you in to the development process.
If you want to get more involved in the development, but still don't know where to start, then please contact the UTN system administrator. He will help you get started.
- Fill in the required template
- Include screenshots and animated GIFs in your pull request whenever possible.
- Follow the repository styleguides.
- 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:
- 📐
:triangular_ruler:when improving the format/structure of the code - 🎨
:art:when improving templates - 🐎
:racehorse:when improving performance - 📝
:memo:when writing docs - 💬
:speech_balloon:when writing translations - 🐛
:bug:when fixing a bug - 🔥
:fire:when removing code or files - 💚
:green_heart:when fixing for CI builds - ✅
:white_check_mark:when adding tests - 🔒
:lock:when dealing with security - ⬆️
:arrow_up:when upgrading dependencies - ⬇️
:arrow_down:when downgrading dependencies
- 📐
- Always adhere to the PEP8 styleguide.
- The closing of a multi-line constructs should match the first character of the first line of this construct.
- Separate import statements.
- Not:
import sys, os
- Not:
- When using multi-line equations, break before the binary operator.
- Use Documentation String.
- Use Type Annotations whenever possible.
- All functions/methods, classes, and modules should be documented in a clear way with references to other relevant code.
def function_with_pep484_type_annotations(param1: int, param2: str) -> bool:
"""Example function with PEP 484 type annotations.
Args:
param1: The first parameter.
param2: The second parameter.
Returns:
The return value. True for success, False otherwise.
"""
return param1 == param2This 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 |
Feature requests. |
bug |
Confirmed bugs or reports that are very likely to be bugs. |
| Label name | Description |
|---|---|
help-wanted |
The UTN system administrator would appreciate help others in resolving these issues. |
more-information-needed |
More information needs to be collected about these problems or feature requests (e.g. steps to reproduce). |
duplicate |
Issues which are duplicates of other issues, i.e. they have been reported before. |
wontfix |
The UTN system administrator has decided not to fix these issues for now, either because they're working as intended or for some other reason. |
invalid |
Issues which aren't valid (e.g. user errors). |
| Label name | Description |
|---|---|
documentation |
Related to any type of documentation. |
feature |
Related to functionality. |
interface |
Related to visual design. |
security |
Related to security. |
translation |
Related to translations or internationalisation. |
| Label name | Description |
|---|---|
work-in-progress |
Pull requests which are still being worked on, more changes will follow. |
needs-review |
Pull requests which need code review, and approval. |
requires-changes |
Pull requests which need to be updated based on review comments and then reviewed again. |
needs-testing |
Pull requests which need manual testing. |