Merge pull request #41 from Brainrotlang/feat/add-test-rule-to-makefile

add test rule to makefile, add contributing doc and pull request template

Author: leo-aa88

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,25 @@
+## Description
+
+<!-- Briefly describe your changes, including any relevant motivation or context. -->
+
+## Related Issue
+
+<!-- If this PR fixes an issue, include "Fixes #<issue_number>". -->
+
+Fixes #<issue_number>
+
+## Type of Change
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+- [ ] Documentation update
+- [ ] Performance improvement
+
+## Checklist
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have documented my changes in the code or documentation
+- [ ] I have added tests that prove my changes work (if applicable)
+- [ ] All new and existing tests pass

CONTRIBUTING.md

@@ -0,0 +1,139 @@
+# Contributing to Brainrot
+
+Welcome to Brainrot! We're excited that you want to contribute. This document provides guidelines and information for contributing to the project.
+
+## Code of Conduct
+
+By participating in this project, you are expected to uphold our Code of Conduct (follows standard open source practices).
+
+## Getting Started
+
+1. Fork the repository
+2. Clone your fork: `git clone https://github.com/yourusername/Brainrot.git`
+3. Create a branch for your changes: `git checkout -b feature/your-feature-name`
+
+## Development Environment
+
+### Prerequisites
+
+- C compiler (gcc recommended)
+- Flex and Bison
+- Make
+
+### Building the Project
+
+```bash
+make clean
+make
+```
+
+### Running Tests
+
+The test suite can be run using:
+
+```bash
+make test
+```
+
+## Project Structure
+
+- `ast.h` / `ast.c`: Abstract Syntax Tree implementation
+- `lang.y`: Bison grammar file
+- `lang.l`: Flex lexer file
+- `examples/`: Example Brainrot programs
+- `tests/`: Test suite
+
+## Adding New Features
+
+1. First, check existing issues and PRs to avoid duplicate work
+2. Create an issue discussing the feature before implementing
+3. Follow the existing code style
+4. Add appropriate tests in `tests/`
+5. Add example usage in `examples/`
+
+## Testing Guidelines
+
+1. All new features must include tests
+2. Test files go in `tests/`
+3. Expected outputs should be added to `expected_results.json`
+4. Tests should cover:
+   - Happy path
+   - Error conditions
+   - Edge cases
+
+## Pull Request Process
+
+1. Update documentation as needed
+2. Add or update tests
+3. Ensure all tests pass
+4. Update CHANGELOG.md if applicable
+5. Reference any related issues
+
+Example PR format:
+
+```markdown
+## Description
+
+Brief description of changes
+
+## Related Issue
+
+Fixes #<issue_number>
+
+## Type of Change
+
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Documentation update
+- [ ] Performance improvement
+```
+
+## Style Guide
+
+### C Code Style
+
+- Use 4 spaces for indentation
+- Maximum line length of 80 characters
+- Function names use snake_case
+- Constants use UPPER_SNAKE_CASE
+- Add comments for complex logic
+- Include parameter documentation for functions
+
+### Grammar Style
+
+- Token names should be descriptive
+- Use consistent naming patterns for similar concepts
+- Document grammar rules with examples
+
+## Documentation
+
+- Keep README.md updated with new features
+- Document all public functions
+- Include examples for new features
+- Use clear, concise language
+
+## Bug Reports
+
+When filing a bug report, include:
+
+1. Brainrot version
+2. Operating system
+3. Complete error message
+4. Minimal reproduction code
+5. Expected vs actual behavior
+
+## Getting Help
+
+If you need help, you can:
+
+1. Check existing issues
+2. Create a new issue with your question
+3. Add [HELP WANTED] tag for implementation assistance
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the same terms as the main project.
+
+## Acknowledgments
+
+Thank you to all contributors who help make Brainrot better!

Makefile

@@ -3,5 +3,8 @@ all:
 	flex lang.l
 	gcc -o brainrot lang.tab.c lex.yy.c ast.c -lfl
 
+test:
+	pytest -v
+
 clean:
 	rm -rf lang.lex.c lang.tab.c lang.tab.h lex.yy.c brainrot

tests/test_brainrot.py

@@ -3,14 +3,24 @@
 import os
 import pytest
 
-# Load expected results from JSON file
-with open("expected_results.json", "r") as file:
+# Get the absolute path to the directory containing the script
+script_dir = os.path.dirname(__file__)
+
+# Construct the full path to the JSON file with expected results
+file_path = os.path.join(script_dir, "expected_results.json")
+
+# Load expected results from the JSON file
+with open(file_path, "r") as file:
     expected_results = json.load(file)
 
 @pytest.mark.parametrize("example,expected_output", expected_results.items())
 def test_brainrot_examples(example, expected_output):
+    # Construct absolute paths for the brainrot executable and example file
+    brainrot_path = os.path.abspath(os.path.join(script_dir, "../brainrot"))
+    example_file_path = os.path.abspath(os.path.join(script_dir, f"../examples/{example}"))
+
     # Define the command to execute
-    command = f".././brainrot < ../examples/{example}"
+    command = f"{brainrot_path} < {example_file_path}"
 
     # Run the command and capture the output
     result = subprocess.run(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True, shell=True)
@@ -32,6 +42,5 @@ def test_brainrot_examples(example, expected_output):
         f"Stderr:\n{result.stderr}"
     )
 
-
 if __name__ == "__main__":
-    pytest.main(["-v", os.path.basename(__file__)])
+    pytest.main(["-v", os.path.abspath(__file__)])