Skip to content

Commit

Permalink
BA-1196: add contributing and code of conduct
Browse files Browse the repository at this point in the history
  • Loading branch information
ds2 committed Oct 2, 2023
1 parent 4575eeb commit ec908df
Show file tree
Hide file tree
Showing 2 changed files with 137 additions and 0 deletions.
51 changes: 51 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# BaseApp Code of Conduct

## Introduction

Welcome to BaseApp! To ensure that the BaseApp community is a welcoming and inclusive space for all contributors, we have established this Code of Conduct. We expect all members of our community to abide by this code when participating in any project-related activities.

## Our Pledge

We are committed to providing a friendly, safe, and harassment-free environment for all, regardless of age, race, ethnicity, nationality, gender identity and expression, sexual orientation, disability, physical appearance, religion, or other personal characteristics.

## Expected Behavior

To foster a positive and inclusive community, we expect all participants to:

- Be respectful and considerate of others' opinions and ideas.
- Use welcoming and inclusive language.
- Refrain from engaging in any form of harassment, discrimination, or intimidation.
- Avoid personal attacks or derogatory comments.
- Give constructive feedback and help others grow.
- Respect the privacy and confidentiality of others.
- Be mindful of cultural differences and varying perspectives.

## Unacceptable Behavior

Unacceptable behaviors include, but are not limited to:

- Harassment, discrimination, or intimidation of any form.
- Hate speech, derogatory comments, or personal attacks.
- Offensive jokes, comments, or imagery.
- Unsolicited attention, including unwelcome advances or requests.
- Invasion of personal space or boundaries.
- Public or private harassment on social media or other platforms.
- Any behavior that makes others feel uncomfortable, unwelcome, or unsafe.

## Reporting Violations

If you witness or experience any behavior that violates this Code of Conduct, please report it to the project maintainers immediately via [info@tsl.io]. All reports will be kept confidential and will be handled in accordance with our guidelines for resolution.

## Enforcement

Project maintainers are responsible for enforcing the Code of Conduct. If a violation is reported and confirmed, appropriate actions will be taken, which may include warnings, temporary or permanent bans from the community, or other measures deemed necessary.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).

## Conclusion

We believe that maintaining a respectful and inclusive environment is essential for the success of our open-source project. We appreciate your cooperation in following this Code of Conduct and contributing to a welcoming community where everyone can thrive.

Thank you for being a part of BaseApp!
86 changes: 86 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# Contributing to BaseApp

Thank you for your interest in contributing to BaseApp! We welcome contributions from the community to help improve and grow the project. Please take a moment to review these guidelines before getting started.

## Table of Contents

- [Reporting Bugs](#reporting-bugs)
- [Requesting Features](#requesting-features)
- [Contributing Code](#contributing-code)
- [Code of Conduct](#code-of-conduct)

---

## Reporting Bugs

When you encounter a bug or unexpected behavior in BaseApp, please follow these steps to report it:

1. Check the [GitHub Issues](https://github.com/silverlogic/baseapp-frontend/issues) to ensure that the bug hasn't already been reported.

2. If the issue hasn't been reported, create a new issue by clicking on the "New Issue" button.

3. Use a clear and descriptive title and provide detailed information about the issue, including steps to reproduce it and any error messages or logs.

4. If possible, include any relevant code snippets or configuration files that can help in diagnosing the problem.

5. Assign appropriate labels and milestones to the issue, if you have access.

## Requesting Features

If you have an idea for a new feature or enhancement in BaseApp, please follow these steps to request it:

1. Check the [GitHub Issues](https://github.com/silverlogic/baseapp-frontend/issues) to ensure that the feature hasn't already been requested.

2. If the feature hasn't been requested, create a new issue by clicking on the "New Issue" button.

3. Use a clear and descriptive title and provide detailed information about the feature request, including its use case and benefits.

4. If possible, include any design or implementation suggestions you may have.

5. Assign appropriate labels and milestones to the issue, if you have access.

## Contributing Code

We welcome code contributions to BaseApp! To contribute code, please follow these steps:

1. Fork the BaseApp repository to your GitHub account.

2. Clone your forked repository to your local development environment.

3. Create a new branch for your feature or bug fix:

```
git checkout -b feature-name
```

4. Make your changes, write tests if applicable, and ensure that the existing tests pass.

5. Commit your changes with a clear and concise commit message:

```
git commit -m "Add feature: Your feature description"
```

6. Push your changes to your forked repository:

```
git push origin feature-name
```

7. Open a Pull Request (PR) against the `master` branch of the BaseApp repository.

8. Provide a descriptive PR title and include details about the changes you've made.

9. Participate in the PR review process, addressing any feedback or comments.

10. Once your PR is approved and passes continuous integration checks, it will be merged into the master repository.

## Code of Conduct

Please note that by contributing to BaseApp, you are expected to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). We want all contributors to maintain a respectful and inclusive environment for everyone.

Thank you for your interest in contributing to BaseApp! Your contributions are greatly appreciated, and they help make the project better for everyone.

If you have any questions or need further assistance, feel free to reach out to us on the GitHub issue tracker or by [contacting us](mailto:info@tsl.io).

Happy coding! 🚀

0 comments on commit ec908df

Please sign in to comment.