diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0555dc9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,94 @@ +# Contributing Guide + +Thank you for investing your time in contributing to our project! + +Please read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community inclusive and respectable. + +This guide will provide an overview of the contribution workflow, including opening an issue, creating a pull request (PR), and the review and merge process. + +## New Contributor Guide + +To familiarize yourself with the project, please read the [README](README.md). Here are some resources to help you get started with open-source contributions: + +- [Finding ways to contribute to open-source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) +- [Setting up Git](https://docs.github.com/en/get-started/quickstart/set-up-git) +- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) +- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests) +- [Getting started with Tauri](https://tauri.app/v1/guides/getting-started/prerequisites) +- [pnpm CLI](https://pnpm.io/pnpm-cli) + +## Getting Started + +### Issues + +#### Creating a New Issue + +If you come across an issue or have a feature request for Nexus, please [search if a related issue has already been reported](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If no relevant issue exists, you can open a new issue using the appropriate [issue form](https://github.com/Polyfrost/Nexus/issues/new/choose). + +#### Solving an Issue + +To find an issue that interests you, you can browse through our [existing issues](https://github.com/Polyfrost/Nexus/issues) and use the available `labels` to narrow down your search (See [Labels](https://github.com/Polyfrost/Nexus/labels) for more information). As a general rule, if you find an issue you want to work on, you are welcome to open a PR with a fix. + +### Making Changes + +#### Making Changes Locally + +The system setup script requires [Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) and [pnpm](https://pnpm.io/installation). Make sure you have them installed before proceeding. + +To make changes locally, follow these steps: + +1. Clone the repository: `git clone https://github.com/Polyfrost/Nexus` +2. Navigate to the project directory: `cd Nexus` +3. For Linux or MacOS users, run: `./.github/scripts/setup-system.sh` + - This will install all required dependencies for Nexus to build. +4. For Windows users, run the following command in PowerShell: `.\.github\scripts\setup-system.ps1` + - This will install pnpm and any other required dependencies for Nexus to build. +5. Install dependencies: `pnpm i` +6. Prepare the build: `pnpm prep` (This will run all necessary codegen and build required dependencies) + +To quickly run only the launcher after `prep`, you can use: + +- `pnpm desktop dev` + + If necessary, react-devtools can be launched using `pnpm react-devtools`. + However, it must be executed before starting the desktop app for it to connect. + +To run the website app: + +- `pnpm website dev` + +If you encounter any issues, ensure that you are using the following versions of Rust, Node and Pnpm: + +- Rust version: **1.70+** +- Node version: **18+** +- Pnpm version: **8.0+** + +After cleaning out your build artifacts using `pnpm clean`, `git clean`, or `cargo clean`, it is necessary to re-run the `setup-system` script. + +Make sure to read the [guidelines](https://docs.polyfrost.org/nexus/developers/prerequisites/guidelines) to ensure that your code follows a similar style to ours. + +### Pull Request + +Once you have finished making your changes, create a pull request (PR) to submit them. + +- Fill out the "Ready for review" template to help reviewers understand your changes and the purpose of your PR. +- If you are addressing an existing issue, don't forget to [link your PR to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue). +- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so that the branch can be updated for merging. +- Once you submit your PR, a team member will review your proposal. They may ask questions or request additional information. +- You may be asked to make changes before the PR can be merged, either through [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. For other changes, you can make them in your fork and commit them to your branch. +- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations). +- If you run into any merge issues, refer to this [git tutorial](https://lab.github.com/githubtraining/managing-merge-conflicts) to help you resolve merge conflicts and other issues. + +### Your PR is Merged + +Congratulations! 🎉🎉 The Polyfrost Nexus team thanks you for your contribution! ✨ + +Once your PR is merged, your changes will be included in the next release of the relavent application. + +### Common Errors + +to be added + +### Credits + +This CONTRIBUTING.md file was inspired by the [github/docs CONTRIBUTING.md](https://github.com/github/docs/blob/main/CONTRIBUTING.md) file, and we extend our gratitude to the original author. |