Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Contributor.md #151

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 88 additions & 0 deletions Contributor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@

# Contributor Guidelines

Thank you for considering contributing to our project! We welcome contributions of all kinds, including bug fixes, new features, documentation, and tests. Please follow the guidelines below to ensure a smooth contribution process.

## How to Contribute

### 1. Fork the Repository
Fork this repository to your GitHub account and clone it locally.

```
git clone https://github.com/your-username/project-name.git
cd project-name
```

### 2. Fork the Repository
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### 2. Fork the Repository
### 2. Fork the Repository

The title above is incorrect!

Follow the project’s setup instructions in the `README.md` file to prepare your development environment.

### 3. Create a Branch
Create a new branch for your contribution. Use a descriptive name.

```
git checkout -b feature/your-feature-name
```

### 4. Make Your Changes
Implement your changes, and ensure they adhere to the project's coding standards.

### 5. Write Tests
Add or update tests to cover your changes, if applicable.

### 6. Run Tests
Run all tests to ensure your changes do not break existing functionality.

```
make test
```

### 7. Commit Your Changes
Write a clear and concise commit message.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Commit messages should addhere to conventional commits standard: https://www.conventionalcommits.org/en/v1.0.0/#specification

(the example below should be ammended to reflect this).

Maybe also highlight expected commit structure: each commit should contain a coherent logical change, a commit should depend only on earlier commits, fixes/changes/updates should be fixed up into existing commits rather than addded as new commits, etc.


```
git add .
git commit -m "Add feature: your-feature-name"
```

### 8. Push Your Changes
Push your branch to your forked repository.

```
git push origin feature/your-feature-name
```

### 9. Push Your Changes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Duplicate of step 8.

Push your branch to your forked repository.

```
git push origin feature/your-feature-name
```

### 10. Create a Pull Request
Open a pull request (PR) to the main repository. Include a detailed description of your changes and any related issue numbers.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would replace "detailed description" with just "description" or "summary". Detailed description should be part of the commit messages, rather than the pull request message. There is nothing wrong with having the details in the pull request as well, however, if it's one or the other, we should be encouraging people to write more detailed commit messages, not more detailed pull requests.


## Code of Conduct
Please read and adhere to our [Code of Conduct](https://github.com/veraison/corim/blob/main/CODE_OF_CONDUCT.md). Respectful and inclusive behavior is expected from all contributors.

## Guidelines for Contributions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section Guidelines for Contributions should now be re-worked/moved and aligned with your top level Contributor Guidelines for smooth logical flow!


- **Bug Reports and Feature Requests:**
Open an issue to report bugs or propose new features before submitting a pull request.

- **Coding Standards:**
Follow the project's coding conventions. Ensure your code is clean, readable, and well-documented.

- **Commit Messages:**
Use descriptive commit messages that explain the purpose of the change.

- **Review Process:**
All pull requests will be reviewed by maintainers. Please be patient and responsive to feedback.

## Need Help?
If you have questions or need assistance, feel free to open an issue or contact the maintainers. We're here to help!