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.

Sign up for GitHub

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

chore(): CONTRIBUTING.md added #56

Merged
merged 1 commit into from
Oct 17, 2023
Merged

chore(): CONTRIBUTING.md added #56

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Contributing to Edux

Thank you for your interest in contributing to Edux! Here's how you can help:

## Reporting Issues

- Check existing issues for your problem, duplicate reports can create extra work.
- If no existing issue exists, create a new one, providing detailed information.

## Submitting Code Changes

1. **Fork the repository** and create your branch from `main`.
2. **Make your changes**: Ensure they are clear, concise, and adhere to our coding standards. Add comments to clarify complex code sections.
3. **Write or adapt tests** as needed to reflect your changes.
4. **Commit your changes**: Use a clear and descriptive commit message.
5. **Submit a Pull Request** with comprehensive request message.

## Code Standards

- Stick to Java coding conventions.
- Keep code clean and readable.
- Ensure all tests are passing.

## Communication

Quick questions? Problem to discuss? Open a GitHub discussion right now.

**Your contributions keep the Edux project alive and thriving. Thank you!**