Skip to content

Conversation

shubhranshu-sahu
Copy link

📄 Description

This PR adds a CONTRIBUTING.md file to the repository.
The document provides clear contribution guidelines for new and existing contributors, helping maintain consistency and improving collaboration.

🛠 Changes Made

  • Added a comprehensive CONTRIBUTING.md file
  • Included instructions for:
    • Forking and cloning the repository
    • Creating and managing branches
    • Committing changes and keeping forks updated
    • Opening Pull Requests with best practices
  • Added tips and a quick PR checklist

📌 Benefits

  • Makes it easier for new contributors to get started
  • Standardizes the contribution workflow
  • Encourages community engagement and organized collaboration

✅ Type of Change

  • Documentation update (CONTRIBUTING.md)

Kindly review this PR, add Labels and merge if.

Closes #3

Comment on lines +37 to +43
### 5. Make your changes
- Follow the existing folder and module structure.
- Test your code changes using:

```bash
cargo run --quiet -- example.lin
```
Copy link
Owner

Choose a reason for hiding this comment

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

optional but useful - maybe suggest contributors run cargo fmt and cargo clippy before committing, helps keep code clean and consistent.


```bash
git add .
git commit -m "Add: description of your change"
Copy link
Owner

Choose a reason for hiding this comment

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

align the commit example with conventional commit format - like feat: add foo interpreter command

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Suggestion: Add a CONTRIBUTING.md File to project
2 participants