-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: update project name in .md files
- Loading branch information
faridevnz
committed
May 29, 2023
1 parent
82ece87
commit eb2fe67
Showing
4 changed files
with
108 additions
and
49 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # Code of Conduct - Cosmodrome | ||
| # Code of Conduct - Cosmodrome 🚀 | ||
|
|
||
| ## Our Pledge | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,44 +1,51 @@ | ||
| <!-- omit in toc --> | ||
| # Contributing to Cosmodrome | ||
|
|
||
| # Contributing to Cosmodrome 🚀 | ||
|
|
||
| First off, thanks for taking the time to contribute! ❤️ | ||
|
|
||
| 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. 🎉 | ||
| 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. 🎉 | ||
|
|
||
| > 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: | ||
| > 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: | ||
| > - Star the project | ||
| > - Tweet about it | ||
| > - Refer this project in your project's readme | ||
| > - Mention the project at local meetups and tell your friends/colleagues | ||
| <!-- omit in toc --> | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [Code of Conduct](#code-of-conduct) | ||
| - [I Have a Question](#i-have-a-question) | ||
| - [I Want To Contribute](#i-want-to-contribute) | ||
| - [Reporting Bugs](#reporting-bugs) | ||
| - [Suggesting Enhancements](#suggesting-enhancements) | ||
| - [Your First Code Contribution](#your-first-code-contribution) | ||
| - [Improving The Documentation](#improving-the-documentation) | ||
| - [I Want To Contribute](#i-want-to-contribute) | ||
| - [Reporting Bugs](#reporting-bugs) | ||
| - [Suggesting Enhancements](#suggesting-enhancements) | ||
| - [Your First Code Contribution](#your-first-code-contribution) | ||
| - [Improving The Documentation](#improving-the-documentation) | ||
| - [Styleguides](#styleguides) | ||
| - [Commit Messages](#commit-messages) | ||
| - [Commit Messages](#commit-messages) | ||
| - [Join The Project Team](#join-the-project-team) | ||
|
|
||
|
|
||
| ## Code of Conduct | ||
|
|
||
| This project and everyone participating in it is governed by the | ||
| [Cosmodrome Code of Conduct](https://github.com/futura-dev/cosmodrome/blob/main/CODE_OF_CONDUCT.md). | ||
| By participating, you are expected to uphold this code. Please report unacceptable behaviour | ||
| to <[email protected]>. | ||
|
|
||
|
|
||
| ## I Have a Question | ||
|
|
||
| > 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). | ||
| > 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). | ||
| 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. | ||
| 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. | ||
|
|
||
| If you then still feel the need to ask a question and need clarification, we recommend the following: | ||
|
|
||
|
|
@@ -51,68 +58,101 @@ We will then take care of the issue as soon as possible. | |
| ## I Want To Contribute | ||
|
|
||
| > ### Legal Notice <!-- omit in toc --> | ||
| > 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. | ||
| > 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. | ||
| ### Reporting Bugs | ||
|
|
||
| <!-- omit in toc --> | ||
|
|
||
| #### Before Submitting a Bug Report | ||
|
|
||
| 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. | ||
| 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. | ||
|
|
||
| - Make sure that you are using the latest version. | ||
| - 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)). | ||
| - 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). | ||
| - Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue. | ||
| - 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)). | ||
| - 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). | ||
| - Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have | ||
| discussed the issue. | ||
| - Collect information about the bug: | ||
| - Stack trace (Traceback) | ||
| - OS, Platform and Version (Windows, Linux, macOS, x86, ARM) | ||
| - Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant. | ||
| - Possibly your input and the output | ||
| - Can you reliably reproduce the issue? And can you also reproduce it with older versions? | ||
| - Stack trace (Traceback) | ||
| - OS, Platform and Version (Windows, Linux, macOS, x86, ARM) | ||
| - Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant. | ||
| - Possibly your input and the output | ||
| - Can you reliably reproduce the issue? And can you also reproduce it with older versions? | ||
|
|
||
| <!-- omit in toc --> | ||
|
|
||
| #### How Do I Submit a Good Bug Report? | ||
|
|
||
| > 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]>. | ||
| > 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]>. | ||
| <!-- You may add a PGP key to allow the messages to be sent encrypted as well. --> | ||
| We use GitHub issues to track bugs and errors. If you run into an issue with the project: | ||
|
|
||
| - 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.) | ||
| - 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.) | ||
| - Explain the behaviour you would expect and the actual behaviour. | ||
| - 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. | ||
| - 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. | ||
| - Provide the information you collected in the previous section. | ||
|
|
||
| Once it's filed: | ||
|
|
||
| - The project team will label the issue accordingly. | ||
| - 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. | ||
| - 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). | ||
| - 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. | ||
| - 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). | ||
|
|
||
| ### Suggesting Enhancements | ||
|
|
||
| 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. | ||
| 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. | ||
|
|
||
| <!-- omit in toc --> | ||
|
|
||
| #### Before Submitting an Enhancement | ||
|
|
||
| - Make sure that you are using the latest version. | ||
| - 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. | ||
| - 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. | ||
| - 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. | ||
| - 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. | ||
| - 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. | ||
| - 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. | ||
|
|
||
| <!-- omit in toc --> | ||
|
|
||
| #### How Do I Submit a Good Enhancement Suggestion? | ||
|
|
||
| Enhancement suggestions are tracked as [GitHub issues](https://github.com/futura-dev/cosmodrome/issues). | ||
|
|
||
| - 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. | ||
| - **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. | ||
| - 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. | ||
| - **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. | ||
| - **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. | ||
| - 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. | ||
| - **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. | ||
|
|
||
| ## Styleguides | ||
|
|
||
| ### Commit Messages | ||
| We're using conventional commit standard for our commit messages, please check the [documentation](https://www.conventionalcommits.org/en/v1.0.0). | ||
|
|
||
| We're using conventional commit standard for our commit messages, please check | ||
| the [documentation](https://www.conventionalcommits.org/en/v1.0.0). | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,12 @@ | ||
| # Cosmodrome | ||
| # Cosmodrome 🚀 | ||
|
|
||
| [](https://github.com/futura-dev/cosmodrome) | ||
| [](https://github.com/futura-dev/cosmodrome/blob/main/LICENSE) | ||
| [](https://github.com/futura-dev/cosmodrome/issues?q=is%3Aissue+is%3Aopen) | ||
| [](https://github.com/futura-dev/cosmodrome/issues?q=is%3Aissue+is%3Aclosed) | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [Getting Started](#getting-started) | ||
| - [Example](#example) | ||
| - [Code of Conduct](#code-of-conduct) | ||
|
|
@@ -18,28 +19,46 @@ | |
| ## Example | ||
|
|
||
| ## Code of Conduct | ||
| 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. | ||
|
|
||
| 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). | ||
| 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. | ||
|
|
||
| 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). | ||
|
|
||
| ## Contributing | ||
| 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) | ||
|
|
||
| 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) | ||
|
|
||
| ## Support | ||
|
|
||
| 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: | ||
| 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: | ||
|
|
||
| - **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. | ||
| - **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. | ||
|
|
||
| - **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. | ||
| - **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. | ||
|
|
||
| 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. | ||
| 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. | ||
|
|
||
| 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. | ||
| 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. | ||
|
|
||
| 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. | ||
| 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. | ||
|
|
||
| We appreciate your interest in this project and look forward to assisting you! | ||
|
|
||
| ## License | ||
| This project is under MIT License. Please check our [LICENSE](https://github.com/futura-dev/cosmodrome/blob/main/LICENSE) page. | ||
|
|
||
| This project is under MIT License. Please check | ||
| our [LICENSE](https://github.com/futura-dev/cosmodrome/blob/main/LICENSE) page. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters