Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dragonked2 committed Aug 15, 2023
1 parent d5b55ae commit 617bd06
Showing 1 changed file with 60 additions and 0 deletions.
60 changes: 60 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Contributing to Egyscan

Thank you for considering contributing to Egyscan! By participating in this project, you contribute to an open-source community that helps improve and develop the Egyscan project.

Please take a moment to review this document before getting started. We appreciate your efforts to make this project better for everyone.

## Table of Contents

- [Code of Conduct](#code-of-conduct)
- [How Can I Contribute?](#how-can-i-contribute)
- [Reporting Bugs](#reporting-bugs)
- [Suggesting Enhancements](#suggesting-enhancements)
- [Working on Issues](#working-on-issues)
- [Submitting Pull Requests](#submitting-pull-requests)
- [Coding Guidelines](#coding-guidelines)
- [Community](#community)

## Code of Conduct

Please review and adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). We are committed to providing a safe and respectful environment for all contributors.

## How Can I Contribute?

### Reporting Bugs

If you find a bug in Egyscan, please [open an issue](https://github.com/dragonked2/Egyscan/issues) and provide as much detail as possible. This includes:

- A clear description of the issue
- Steps to reproduce the problem
- Information about your environment (operating system, browser, etc.)

### Suggesting Enhancements

We welcome suggestions for improving Egyscan! If you have an idea for a new feature or an enhancement, please [open an issue](https://github.com/dragonked2/Egyscan/issues) and describe your suggestion.

### Working on Issues

Check our [issue tracker](https://github.com/dragonked2/Egyscan/issues) for open issues that you can help with. If you plan to work on an issue, please comment on it to let others know. This helps avoid duplicated efforts.

### Submitting Pull Requests

1. Fork the repository and create a new branch for your feature/fix.
2. Implement your changes with clear commit messages.
3. Test your changes thoroughly.
4. Ensure your code adheres to our [coding guidelines](#coding-guidelines).
5. Submit a pull request to the `main` branch of the Egyscan repository.

## Coding Guidelines

To maintain a consistent codebase, please follow these guidelines when contributing to Egyscan:

- Follow the coding style used in the project.
- Write clear and concise code and comments.
- Include unit tests when adding new functionality.

## Community

Join our community on [GitHub Discussions](link-to-discussions) to connect with other contributors, ask questions, and share ideas.

Thank you for contributing to Egyscan! Your efforts help make this project better for everyone.

0 comments on commit 617bd06

Please sign in to comment.