You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
First off, thanks for taking the time to contribute! ❤️
5
6
6
-
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
7
+
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways
8
+
to help and details about how this project handles them. Please make sure to read the relevant section before making
9
+
your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The
10
+
community looks forward to your contributions. 🎉
7
11
8
-
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
12
+
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support
13
+
> the project and show your appreciation, which we would also be very happy about:
9
14
> - Star the project
10
15
> - Tweet about it
11
16
> - Refer this project in your project's readme
12
17
> - Mention the project at local meetups and tell your friends/colleagues
> If you want to ask a question, we assume that you have read the available [Documentation](https://github.com/futura-dev/cosmodrome/blob/main/README.md).
43
+
> If you want to ask a question, we assume that you have read the
44
+
> available [Documentation](https://github.com/futura-dev/cosmodrome/blob/main/README.md).
40
45
41
-
Before you ask a question, it is best to search for existing [Issues](https://github.com/futura-dev/cosmodrome/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
46
+
Before you ask a question, it is best to search for existing [Issues](https://github.com/futura-dev/cosmodrome/issues)
47
+
that might help you. In case you have found a suitable issue and still need clarification, you can write your question
48
+
in this issue. It is also advisable to search the internet for answers first.
42
49
43
50
If you then still feel the need to ask a question and need clarification, we recommend the following:
44
51
@@ -51,68 +58,101 @@ We will then take care of the issue as soon as possible.
51
58
## I Want To Contribute
52
59
53
60
> ### Legal Notice <!-- omit in toc -->
54
-
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project licence.
61
+
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the
62
+
> necessary rights to the content and that the content you contribute may be provided under the project licence.
55
63
56
64
### Reporting Bugs
57
65
58
66
<!-- omit in toc -->
67
+
59
68
#### Before Submitting a Bug Report
60
69
61
-
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
70
+
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to
71
+
investigate carefully, collect information and describe the issue in detail in your report. Please complete the
72
+
following steps in advance to help us fix any potential bug as fast as possible.
62
73
63
74
- Make sure that you are using the latest version.
64
-
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://github.com/futura-dev/cosmodrome/blob/main/README.md). If you are looking for support, you might want to check [this section](#i-have-a-question)).
65
-
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/futura-dev/cosmodrome/issues?q=label%3Abug).
66
-
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
75
+
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment
76
+
components/versions (Make sure that you have read
77
+
the [documentation](https://github.com/futura-dev/cosmodrome/blob/main/README.md). If you are looking for support, you
78
+
might want to check [this section](#i-have-a-question)).
79
+
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there
80
+
is not already a bug report existing for your bug or error in
81
+
the [bug tracker](https://github.com/futura-dev/cosmodrome/issues?q=label%3Abug).
82
+
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have
83
+
discussed the issue.
67
84
- Collect information about the bug:
68
-
- Stack trace (Traceback)
69
-
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
70
-
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
71
-
- Possibly your input and the output
72
-
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
85
+
- Stack trace (Traceback)
86
+
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
87
+
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
88
+
- Possibly your input and the output
89
+
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
73
90
74
91
<!-- omit in toc -->
92
+
75
93
#### How Do I Submit a Good Bug Report?
76
94
77
-
> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <[email protected]>.
95
+
> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue
96
+
> tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <[email protected]>.
78
97
<!-- You may add a PGP key to allow the messages to be sent encrypted as well. -->
79
98
80
99
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
81
100
82
-
- Open an [Issue](https://github.com/futura-dev/cosmodrome/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
101
+
- Open an [Issue](https://github.com/futura-dev/cosmodrome/issues/new). (Since we can't be sure at this point whether it
102
+
is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
83
103
- Explain the behaviour you would expect and the actual behaviour.
84
-
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
104
+
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to
105
+
recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem
106
+
and create a reduced test case.
85
107
- Provide the information you collected in the previous section.
86
108
87
109
Once it's filed:
88
110
89
111
- The project team will label the issue accordingly.
90
-
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
91
-
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
112
+
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no
113
+
obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs
114
+
with the `needs-repro` tag will not be addressed until they are reproduced.
115
+
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such
116
+
as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
92
117
93
118
### Suggesting Enhancements
94
119
95
-
This section guides you through submitting an enhancement suggestion for Cosmodrome, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
120
+
This section guides you through submitting an enhancement suggestion for Cosmodrome, **including completely new features
121
+
and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community
122
+
to understand your suggestion and find related suggestions.
96
123
97
124
<!-- omit in toc -->
125
+
98
126
#### Before Submitting an Enhancement
99
127
100
128
- Make sure that you are using the latest version.
101
-
- Read the [documentation](https://github.com/futura-dev/cosmodrome/blob/main/README.md) carefully and find out if the functionality is already covered, maybe by an individual configuration.
102
-
- Perform a [search](https://github.com/futura-dev/cosmodrome/issues) 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.
103
-
- 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. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
129
+
- Read the [documentation](https://github.com/futura-dev/cosmodrome/blob/main/README.md) carefully and find out if the
130
+
functionality is already covered, maybe by an individual configuration.
131
+
- Perform a [search](https://github.com/futura-dev/cosmodrome/issues) to see if the enhancement has already been
132
+
suggested. If it has, add a comment to the existing issue instead of opening a new one.
133
+
- 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
134
+
convince the project's developers of the merits of this feature. Keep in mind that we want features that will be
135
+
useful to the majority of our users and not just a small subset. If you're just targeting a minority of users,
136
+
consider writing an add-on/plugin library.
104
137
105
138
<!-- omit in toc -->
139
+
106
140
#### How Do I Submit a Good Enhancement Suggestion?
107
141
108
142
Enhancement suggestions are tracked as [GitHub issues](https://github.com/futura-dev/cosmodrome/issues).
109
143
110
144
- Use a **clear and descriptive title** for the issue to identify the suggestion.
111
145
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
112
-
-**Describe the current behaviour** and **explain which behaviour you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
113
-
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to.
114
-
-**Explain why this enhancement would be useful** to most Cosmodrome users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
146
+
-**Describe the current behaviour** and **explain which behaviour you expected to see instead** and why. At this point
147
+
you can also tell which alternatives do not work for you.
148
+
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part
149
+
which the suggestion is related to.
150
+
-**Explain why this enhancement would be useful** to most Cosmodrome users. You may also want to point out the other
151
+
projects that solved it better and which could serve as inspiration.
115
152
116
153
## Styleguides
154
+
117
155
### Commit Messages
118
-
We're using conventional commit standard for our commit messages, please check the [documentation](https://www.conventionalcommits.org/en/v1.0.0).
156
+
157
+
We're using conventional commit standard for our commit messages, please check
158
+
the [documentation](https://www.conventionalcommits.org/en/v1.0.0).
As contributors and maintainers of this open-source web project, we pledge to provide a welcoming and inclusive environment for everyone. We value the participation of individuals from diverse backgrounds and perspectives and aim to foster a respectful and harassment-free community.
22
22
23
-
To ensure a positive experience for all community members, we have established the following code of conduct that applies to all project-related activities and interactions, both online and offline. By participating in this project, you are expected to uphold these [guidelines](https://github.com/futura-dev/cosmodrome/blob/main/CODE_OF_CONDUCT.md).
23
+
As contributors and maintainers of this open-source web project, we pledge to provide a welcoming and inclusive
24
+
environment for everyone. We value the participation of individuals from diverse backgrounds and perspectives and aim to
25
+
foster a respectful and harassment-free community.
26
+
27
+
To ensure a positive experience for all community members, we have established the following code of conduct that
28
+
applies to all project-related activities and interactions, both online and offline. By participating in this project,
29
+
you are expected to uphold these [guidelines](https://github.com/futura-dev/cosmodrome/blob/main/CODE_OF_CONDUCT.md).
24
30
25
31
## Contributing
26
-
Thank you for considering contributing to this open-source web project! We appreciate your interest and support. To ensure a smooth collaboration process, please follow the [guidelines](https://github.com/futura-dev/cosmodrome/blob/main/CONTRIBUTING.md)
32
+
33
+
Thank you for considering contributing to this open-source web project! We appreciate your interest and support. To
34
+
ensure a smooth collaboration process, please follow
35
+
the [guidelines](https://github.com/futura-dev/cosmodrome/blob/main/CONTRIBUTING.md)
27
36
28
37
## Support
29
38
30
-
If you need assistance, have questions, or want to provide feedback related to this open-source web project, there are several ways to get support:
39
+
If you need assistance, have questions, or want to provide feedback related to this open-source web project, there are
40
+
several ways to get support:
31
41
32
-
-**Issue Tracker**: Check the project's issue tracker on [GitHub](https://github.com/futura-dev/cosmodrome/issues) to see if your question or issue has already been addressed. If not, feel free to open a new issue with a detailed description.
42
+
-**Issue Tracker**: Check the project's issue tracker on [GitHub](https://github.com/futura-dev/cosmodrome/issues) to
43
+
see if your question or issue has already been addressed. If not, feel free to open a new issue with a detailed
44
+
description.
33
45
34
-
-**Email**: You can also reach out to the project maintainers directly via email at ([email protected])[mailto:[email protected]]. Please allow for a reasonable response time.
46
+
-**Email**: You can also reach out to the project maintainers directly via email at (
Before seeking support, make sure to review the project's documentation and readme file, as they may contain helpful information and answers to common questions.
49
+
Before seeking support, make sure to review the project's documentation and readme file, as they may contain helpful
50
+
information and answers to common questions.
37
51
38
-
When seeking support or reporting issues, please provide as much relevant information as possible, such as the version of the project you are using, the steps to reproduce the problem, and any error messages encountered. This will help us better understand and assist you with your query.
52
+
When seeking support or reporting issues, please provide as much relevant information as possible, such as the version
53
+
of the project you are using, the steps to reproduce the problem, and any error messages encountered. This will help us
54
+
better understand and assist you with your query.
39
55
40
-
While we strive to provide timely and helpful support, please note that response times may vary depending on the availability of project maintainers and the complexity of the issue.
56
+
While we strive to provide timely and helpful support, please note that response times may vary depending on the
57
+
availability of project maintainers and the complexity of the issue.
41
58
42
59
We appreciate your interest in this project and look forward to assisting you!
43
60
44
61
## License
45
-
This project is under MIT License. Please check our [LICENSE](https://github.com/futura-dev/cosmodrome/blob/main/LICENSE) page.
0 commit comments