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.

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

[DOC] Add CONTRIBUTING.md and CODE_OF_CONDUCT.md #24

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
45 changes: 45 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

- Using welcoming and inclusive language.
- Being respectful of differing viewpoints and experiences.
- Gracefully accepting constructive criticism.
- Focusing on what is best for the community.
- Showing empathy towards other community members.

Examples of unacceptable behavior include:

- The use of sexualized language or imagery and unwelcome sexual attention or advances.
- Trolling, insulting/derogatory comments, and personal or political attacks.
- Public or private harassment.
- Publishing others' private information without explicit permission.
- Other conduct which could reasonably be considered inappropriate in a professional setting.

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that do not align with this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.

## Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project include using an official project email address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [[email protected]](mailto:[email protected]). All complaints will be reviewed and investigated and will result in a response deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct/](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
155 changes: 155 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
# Contributing to DataLoom

*First of all, thank you for considering contributing to DataLoom! We welcome contributions from the community. By participating in this project, you agree to abide by our guidelines and our Code of Conduct.*

---

## Table of Contents

- [Code of Conduct](#code-of-conduct)
- [How to Contribute](#how-to-contribute)
- [Reporting Bugs](#reporting-bugs)
- [Suggesting Enhancements](#suggesting-enhancements)
- [Pull Requests](#pull-requests)
- [Development Guidelines](#development-guidelines)
- [Tech Stack](#tech-stack)
- [Coding Standards](#coding-standards)
- [Commit Messages](#commit-messages)
- [Testing](#testing)
- [Documentation](#documentation)
- [License](#license)
- [Questions](#questions)

---

## Code of Conduct

Please note that this project adheres to a [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]](mailto:[email protected]).

---

## How to Contribute

There are several ways you can contribute to DataLoom:

### Reporting Bugs

- **Check the existing issues** to see if your bug has already been reported.
- **Create a new issue** using our [Bug Report Template](.github/ISSUE_TEMPLATE/bug_report.md).
- Include a clear description, steps to reproduce, screenshots (if applicable), and the environment details.

### Suggesting Enhancements

- If you have an idea for a new feature or an improvement, please open an issue using the [Feature Request Template](.github/ISSUE_TEMPLATE/feature_request.md).
- Describe your idea clearly and, if possible, include mockups or examples.

### Pull Requests

If you want to fix a bug or add a new feature:

1. **Fork the Repository:** Click the fork button at the top right of the repository page.

2. **Clone your Fork:**
```bash
git clone https://github.com/your-username/DataLoom.git
cd DataLoom
```

3. **Create a Branch:**
```bash
git checkout -b feature/your-feature-name
```

4. **Make Changes:**
- Follow our [Coding Standards](#coding-standards).
- Ensure your changes align with the project's [Tech Stack](#tech-stack).
- Update tests and documentation as applicable.

5. **Commit Your Changes:**
- Write clear commit messages (see [Commit Messages](#commit-messages)).

6. **Push Your Branch:**
```bash
git push origin feature/your-feature-name
```

7. **Open a Pull Request:**
- Follow the Pull Request Template to provide all necessary information.
- Link your PR to any related issues.

---

## Development Guidelines

### Tech Stack
DataLoom is built using the following technologies:

- **Frontend:**
Developed using [React.js](https://react.dev/).


- **Backend:**
Built with [Node.js](https://nodejs.org/en) and [Express.js](https://expressjs.com/).


- **Database:**
Utilizes [MongoDB](https://www.mongodb.com/) for data storage.


- **Data Processing:**
Uses [Python](https://www.python.org/) along with popular libraries for data transformation tasks.


- **Version Control:**
Managed with [Git](https://git-scm.com/).


### Coding Standards

- **Formatting:** Use [Prettier](https://prettier.io/) for code formatting to maintain consistency across the codebase.

- **Linting:** Ensure your code passes all linting checks using [ESLint](https://eslint.org/).

- **Comments:** Write clear comments where necessary. Complex logic should be well-documented.

### Commit Messages

Use clear and concise commit messages. A good commit message should include:

- A short summary (less than 50 characters).
- A detailed description if needed (wrapped at 72 characters).
- Reference the issue number when relevant (e.g., Fixes #123).

### Testing

- **Unit Tests:** Ensure that your changes include appropriate unit tests.

- **Manual Testing:** Test the changes manually in the environment before opening a PR.

- **CI/CD:** All tests must pass in our continuous integration pipeline. Please check the CI status for details.

---

## Documentation

- Keep the documentation up-to-date with your changes.
- Update or create new documentation if you add new features or make significant changes.
- Documentation can be found in the `/docs` directory. Follow the same style guidelines as the rest of the project.

---

## License

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

---

## Questions

If you have any questions, feel free to reach out by opening an issue or contacting one of the maintainers at [[email protected]](mailto:[email protected]).

**Thank you for contributing to DataLoom!**