mirror of
https://github.com/MillironX/XAM.jl.git
synced 2024-11-14 22:33:14 +00:00
Add .github templates
This commit is contained in:
parent
17ea000940
commit
78d2329f70
2 changed files with 87 additions and 0 deletions
40
.github/ISSUE_TEMPLATE.md
vendored
Normal file
40
.github/ISSUE_TEMPLATE.md
vendored
Normal file
|
@ -0,0 +1,40 @@
|
||||||
|
<!--- Provide a general summary of the issue in the Title above -->
|
||||||
|
|
||||||
|
> _This template is rather extensive. Fill out all that you can, if are a new contributor or you're unsure about any section, leave it unchanged and a reviewer will help you_ :smile:. _This template is simply a tool to help everyone remember the BioJulia guidelines, if you feel anything in this template is not relevant, simply delete it._
|
||||||
|
|
||||||
|
## Expected Behavior
|
||||||
|
<!--- If you're describing a bug, tell us what you expect to happen -->
|
||||||
|
<!--- If you're suggesting a change/improvement, tell us how it should work -->
|
||||||
|
|
||||||
|
## Current Behavior
|
||||||
|
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
|
||||||
|
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
|
||||||
|
|
||||||
|
## Possible Solution / Implementation
|
||||||
|
<!--- If describing a bug, suggest a fix/reason for the bug (optional) -->
|
||||||
|
<!--- If you're suggesting a change/improvement, suggest ideas how to implement the addition or change -->
|
||||||
|
|
||||||
|
## Steps to Reproduce (for bugs)
|
||||||
|
<!--- You may include copy/pasteable snippets or a list of steps to reproduce the bug -->
|
||||||
|
1.
|
||||||
|
2.
|
||||||
|
3.
|
||||||
|
4.
|
||||||
|
|
||||||
|
<!--- Optionally, provide a link to a live example -->
|
||||||
|
<!--- You can use [this tool](https://www.cockos.com/licecap/) -->
|
||||||
|
<!--- ...Or [this tool](https://github.com/colinkeenan/silentcast) -->
|
||||||
|
<!--- ...Or [this tool](https://github.com/GNOME/byzanz) on Linux -->
|
||||||
|
|
||||||
|
## Context
|
||||||
|
<!--- How has this issue affected you? What are you trying to accomplish? -->
|
||||||
|
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
|
||||||
|
|
||||||
|
## Your Environment
|
||||||
|
<!--- Include as many relevant details about the environment you experienced the bug in -->
|
||||||
|
- Package Version used:
|
||||||
|
- Julia Version used:
|
||||||
|
- Operating System and version (desktop or mobile):
|
||||||
|
- Link to your project:
|
||||||
|
|
||||||
|
<!-- Can you list installed packages here? -->
|
47
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
47
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
@ -0,0 +1,47 @@
|
||||||
|
# A clear and descriptive title (No issue numbers please)
|
||||||
|
|
||||||
|
> _This template is rather extensive. Fill out all that you can, if are a new contributor or you're unsure about any section, leave it unchanged and a reviewer will help you_ :smile:. _This template is simply a tool to help everyone remember the BioJulia guidelines, if you feel anything in this template is not relevant, simply delete it._
|
||||||
|
|
||||||
|
## Types of changes
|
||||||
|
|
||||||
|
This PR implements the following changes:
|
||||||
|
_(Please tick any or all of the following that are applicable)_
|
||||||
|
|
||||||
|
* [ ] :sparkles: New feature (A non-breaking change which adds functionality).
|
||||||
|
* [ ] :bug: Bug fix (A non-breaking change, which fixes an issue).
|
||||||
|
* [ ] :boom: Breaking change (fix or feature that would cause existing functionality to change).
|
||||||
|
|
||||||
|
## :clipboard: Additional detail
|
||||||
|
|
||||||
|
- If you have implemented new features or behaviour
|
||||||
|
- **Provide a description of the addition** in as many details as possible.
|
||||||
|
|
||||||
|
- **Provide justification of the addition**.
|
||||||
|
|
||||||
|
- **Provide a runnable example of use of your addition**. This lets reviewers
|
||||||
|
and others try out the feature before it is merged or makes it's way to release.
|
||||||
|
|
||||||
|
- If you have changed current behaviour...
|
||||||
|
- **Describe the behaviour prior to you changes**
|
||||||
|
|
||||||
|
- **Describe the behaviour after your changes** and justify why you have made the changes,
|
||||||
|
Please describe any breakages you anticipate as a result of these changes.
|
||||||
|
|
||||||
|
- **Does your change alter APIs or existing exposed methods/types?**
|
||||||
|
If so, this may cause dependency issues and breakages, so the maintainer
|
||||||
|
will need to consider this when versioning the next release.
|
||||||
|
|
||||||
|
- If you are implementing changes that are intended to increase performance, you
|
||||||
|
should provide the results of a simple performance benchmark exercise
|
||||||
|
demonstrating the improvement. Especially if the changes make code less legible.
|
||||||
|
|
||||||
|
## :ballot_box_with_check: Checklist
|
||||||
|
|
||||||
|
- [ ] :art: The changes implemented is consistent with the [julia style guide](https://docs.julialang.org/en/stable/manual/style-guide/).
|
||||||
|
- [ ] :blue_book: I have updated and added relevant docstrings, in a manner consistent with the [documentation styleguide](https://docs.julialang.org/en/stable/manual/documentation/).
|
||||||
|
- [ ] :blue_book: I have added or updated relevant user and developer manuals/documentation in `docs/src/`.
|
||||||
|
- [ ] :ok: There are unit tests that cover the code changes I have made.
|
||||||
|
- [ ] :ok: The unit tests cover my code changes AND they pass.
|
||||||
|
- [ ] :pencil: I have added an entry to the `[UNRELEASED]` section of the manually curated `CHANGELOG.md` file for this repository.
|
||||||
|
- [ ] :ok: All changes should be compatible with the latest stable version of Julia.
|
||||||
|
- [ ] :thought_balloon: I have commented liberally for any complex pieces of internal code.
|
Loading…
Reference in a new issue