Skip to content

Latest commit

 

History

History
54 lines (33 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

54 lines (33 loc) · 2.14 KB

Contributing Guidelines

Welcome to our project! We're excited to have you as a potential contributor. Before you get started, please take a moment to read through these guidelines to ensure a smooth and collaborative contribution process.

How to Contribute

There are several ways you can contribute to our project:

  1. Reporting Issues: If you encounter a bug, have a feature request, or notice any other issues, please open an issue on our issue tracker.

  2. Suggesting Enhancements: If you have ideas for improving our project, feel free to open an issue with your suggestions.

  3. Code Contributions: We welcome code contributions! If you'd like to fix a bug or add a new feature, follow these steps:

    • Fork the repository.
    • Create a new branch for your changes.
    • Make your changes and ensure they are thoroughly tested.
    • Submit a pull request, detailing the changes you've made and any relevant information.

Getting Started

To set up the project locally, follow these steps:

  1. Clone the repository:

git clone https://github.com/ogzkesk/EonAd.git cd EonAd

  1. Install dependencies:

npm start

Coding Standards

We follow a set of coding standards to maintain consistency in our codebase:

  • Use tabs for indentation.
  • Use meaningful variable and function names.
  • Comment your code where necessary.

Pull Request Process

  1. Make sure your code adheres to our coding standards.
  2. Provide a clear and descriptive pull request title.
  3. Describe the purpose of your pull request and any changes you've made.
  4. Assign relevant reviewers to your pull request.

Code of Conduct

Please note that by participating in this project, you agree to abide by our Code of Conduct.

Thank you for considering contributing to our project!


This CONTRIBUTING.md file is based on the Contributor Covenant. For answers to common questions about this code of conduct, see the FAQ.