-
Notifications
You must be signed in to change notification settings - Fork 156
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Add new contributors guide for prs and issues
Signed-off-by: Vincent T. <vtaylor@microsoft.com>
- Loading branch information
Showing
1 changed file
with
125 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,125 @@ | ||
(Note: placing this here as a placeholder location so that the content can be worked on) | ||
|
||
# Guide for First-Time Contributors to Headlamp | ||
|
||
Welcome to the Headlamp project! We're excited to have you here. Whether you're submitting a **Pull Request (PR)** or reporting an **Issue**, follow this guide to get started smoothly. | ||
|
||
--- | ||
|
||
## Submitting Your First Pull Request (PR) | ||
|
||
Before creating a PR, make sure your code is properly tested and formatted according to our standards. | ||
|
||
### 1. Run Tests and Formatting Scripts | ||
|
||
Navigate to the `frontend` folder and run the following commands: | ||
|
||
- `cd frontend` | ||
- `npm run test` – Run the test suite | ||
- `npm run tsc` – Check for TypeScript errors | ||
- `npm run format` – Format your code | ||
|
||
These scripts ensure your code is functional, well-typed, and consistently formatted before submission. | ||
|
||
--- | ||
|
||
### 2. Follow Atomic Commit Styling | ||
|
||
Use **atomic commits** to keep each commit focused on a single change. Follow this structure for your commit messages: | ||
|
||
`<scope>: <concise description>` | ||
|
||
**Examples:** | ||
|
||
- `frontend: Fix home button not navigating home` | ||
- `backend: Add new API route for Helm chart details` | ||
|
||
--- | ||
|
||
### 3. Write a Descriptive PR Description | ||
|
||
Include the following details in your PR description: | ||
|
||
- **Summary** of the changes and **why** they were needed. | ||
- **Link to the related issue** (if applicable). | ||
- **Steps to test** the changes. | ||
|
||
**Example:** | ||
|
||
**This PR fixes the home button bug where the button did not navigate back to the homepage.** | ||
|
||
**Steps to Test:** | ||
1. Click on the 'Home' button in the sidebar. | ||
2. Verify that it navigates to the main screen. | ||
|
||
--- | ||
|
||
### 4. Use Labels to Organize PRs | ||
|
||
Add relevant labels to your PR to help with triaging and prioritization. Some common labels: | ||
|
||
- bug | ||
- enhancement | ||
- documentation | ||
|
||
--- | ||
|
||
### 5. Ping Someone for Review | ||
|
||
Tag a project **maintainer or reviewer** to ensure your PR is reviewed promptly. | ||
|
||
**Example:** | ||
|
||
@maintainer_name Could you review this PR? | ||
|
||
--- | ||
|
||
## Submitting Your First Issue | ||
|
||
When creating an issue, follow these guidelines to help us understand and resolve it efficiently. | ||
|
||
### 1. Search for Existing Issues | ||
|
||
Use the search function in the **Issues** tab to check if your issue already exists. If it does, consider adding a comment to the existing issue instead of creating a new one. | ||
|
||
--- | ||
|
||
### 2. Use a Clear Description | ||
|
||
Structure your issue description like this: | ||
|
||
**Summary:** | ||
The home button is not navigating back to the homepage. | ||
|
||
**Expected Behavior:** | ||
Clicking the 'Home' button should navigate to the homepage. | ||
|
||
**Observed Behavior:** | ||
Clicking the 'Home' button does nothing. | ||
|
||
**Steps to Reproduce:** | ||
1. Launch the app. | ||
2. Click on 'Home' in the sidebar. | ||
|
||
--- | ||
|
||
### 3. Add Relevant Labels | ||
|
||
Use labels to categorize your issue properly: | ||
|
||
- bug | ||
- feature request | ||
- question | ||
- help wanted | ||
|
||
This helps maintainers and contributors manage and prioritize issues efficiently. | ||
|
||
--- | ||
|
||
## Need Help? | ||
|
||
If you get stuck, feel free to ask questions in the **Discussions** tab or tag a maintainer in your issue or PR. We're here to help! | ||
|
||
--- | ||
|
||
Thank you for contributing to Headlamp! Every contribution, no matter how small, makes a big difference. |