CONTRIBUTING.md · Gitee 极速下载/xtreme1

# Contribute to Xtreme1

Thank you very much for your interest in the Xtreme1 project. We welcome your suggestions, comments (including criticisms) and contributions to the Xtreme1 project.

Your suggestions and comments on Xtreme1 can be made directly through GitHub's [Issues](https://github.com/xtreme1-io/xtreme1/issues/new/choose).

There are many ways to participate in and contribute to Xtreme1 projects: code implementation, test writing, document improvement, and so on. Any contribution will be welcomed and you will be added to the list of contributors.

## Initial contact

For the first time in Xtreme1 community, you can:

* Follow [Xtreme1 GitHub](https://github.com/xtreme1-io/xtreme1)
* Follow [Xtreme1 Twitter](https://twitter.com/Xtreme1io)
* Follow [Xtreme1 YouTube](https://www.youtube.com/@basicai)
* Follow [Xtreme1 LinkedIn](https://linkedin.com/company/basicaius)
* Follow [Xtreme1 Facebook](https://www.facebook.com/basicaiinc)
* Follow [Xtreme1 Reddit](https://www.reddit.com/r/BasicAI)

Learn the development trends of Xtreme1 project in time and give your opinions on the topics you are concerned about.

## Xtreme1's code and documentation

As you can see from [Xtreme1 GitHub](https://github.com/xtreme1-io/xtreme1), Xtreme1 code base mainly consists of two parts: Frontend (FE) and Backend (BE). Documents are also maintained on [GitHub](https://github.com/xtreme1-io/docs), and deployed on [GitBook](https://www.gitbook.com/). Details of these components can be found in the following table:

| Component Name | Component Description | Related Language |
|----------------|-----------------------|------------------|
| [Frontend (FE)](https://github.com/xtreme1-io/xtreme1) | Xtreme1 web ui | Java |
| [Backend (BE)](https://github.com/xtreme1-io/xtreme1)  | Xtreme1 api service | JavaScript, TypeScript, HTML, CSS |
| [Docs](https://github.com/xtreme1-io/docs)        | Xtreme1 documents | Markdown |

## Improving documentation

Documentation is the most important way for you to understand Xtreme1, and it's where we need help most!

Browse the document, you can deepen your understanding of Xtreme1, can also help you understand Xtreme1's function and technical details, if you find that the document has problems, please contact us in time;

If you are interested in improving the quality of documents, whether it is revising the address of a page, correcting a link, and writing a better introductory document, we are very welcome!

Most of our documents are written in Markdown format, and you can modify and submit document changes directly in [Xtreme1 Docs](https://github.com/xtreme1-io/docs).

## If a Bug or problem is found

If a Bug or problem is found, you can directly raise a new Issue through GitHub's [Issues](https://github.com/xtreme1-io/xtreme1/issues/new/choose), and we will have someone deal with it regularly.

You can also fix it yourself by reading and analyzing the source code (of course, it's better to talk to us before that, maybe someone has fixed the same problem) and submit a [Pull Request](https://github.com/xtreme1-io/xtreme1/compare).

## Modify the code and submit PR (Pull Request)

You can download the code, build and run it for a try (refer to [Frontend README](https://github.com/xtreme1-io/xtreme1/blob/main/frontend/README.md) and [Backend README](https://github.com/xtreme1-io/xtreme1/blob/main/backend/README.md)) to see if it works as you expected. If you have problems, you can contact us directly, ask questions or fix them by reading and analyzing the source code.

Whether it's fixing Bugs or adding Features, we're all very welcome. If you want to submit code to Xtreme1, you need to create a new branch for your submitted code from your forked repository and submit a PR.

Gitee 极速下载/xtreme1

简介

发行版

贡献者

近期动态

Gitee 极速下载/xtreme1 .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

Gitee 极速下载/xtreme1