Skip to content

Commit d6af5e3

Browse files
authored
Merge branch 'develop' into gh_action
2 parents 2179c40 + 6c475f1 commit d6af5e3

File tree

2 files changed

+137
-0
lines changed

2 files changed

+137
-0
lines changed

CODE-of-CONDUCT.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Code of Conduct
2+
3+
## Introduction
4+
Welcome to the WeatherGenerator development community.
5+
6+
We are committed to providing a welcoming and inspiring environment for all contributors. Our goal is to develop high-quality software and ensure it is robust, reliable, and available as open-source for the benefit of the wider community and open for external contributors.
7+
8+
This Code of Conduct outlines our expectations for participants to foster a positive, productive, and inclusive community.
9+
10+
## Reference
11+
This Code of Conduct is adapted and meant to be a summarised form of the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.
12+
13+
If the interpretation of this code of conduct is in any way in conflict with the Contributor Covenant, the Contributor Covenant takes precedence.
14+
15+
## Our Standards
16+
All contributors are expected to adhere to the following standards:
17+
18+
1. **Respectful Communication**:
19+
- Demonstrate empathy and kindness towards others.
20+
- Use inclusive and respectful language.
21+
- Critique ideas, not people.
22+
- Avoid offensive or derogatory comments.
23+
24+
2. **Collaboration**:
25+
- Be open to constructive feedback.
26+
- Share knowledge and help others.
27+
- Respect differing viewpoints and experiences.
28+
29+
3. **Commitment to Quality**:
30+
- Write clear, concise, and well-documented code.
31+
- Follow established coding standards and guidelines.
32+
- Test and review code thoroughly before submission.
33+
- Provide new tests for new features.
34+
- Submit helpful and constructive feedback on code reviews.
35+
36+
4. **Inclusivity**:
37+
- Be welcoming to new contributors.
38+
- Ensure that all community members can participate fully.
39+
- Encourage diversity in all its forms.
40+
41+
5. **Professionalism**:
42+
- Act professionally in all interactions.
43+
- Refrain from disruptive behavior or harassment.
44+
- Uphold the integrity and reputation of the ECMWF community.
45+
46+
## Our Responsibilities
47+
Repository managers are responsible for clarifying and enforcing standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
48+
49+
## Scope
50+
This Code of Conduct applies to all project spaces, including GitHub repositories, issue trackers, forums, chat channels, and any other means of communication. It also applies when an individual is representing the project or its community in public spaces.
51+
52+
## Reporting Issues
53+
If you experience or witness unacceptable behavior, or have any other concerns, please report it by contacting `development (at) weathergenerator.eu`.
54+
55+
All complaints will be reviewed and investigated promptly and fairly.
56+
57+
## Enforcement
58+
Enforcement shall take the form of warnings, temporary or permanent bans, as defined in the [Contributor Covenant](https://www.contributor-covenant.org/)
59+
60+
## Contacts
61+
62+
For any questions or further information, please contact `development (at) weathergenerator.eu`

CONTRIBUTING.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# WeatherGenerator Contributing Guide
2+
3+
Thank you for your interest in contributing to the WeatherGenerator! We welcome contributions to help build and develop the WeatherGenerator. This guide will help you get started with contributing to our project.
4+
5+
## Table of Contents
6+
7+
1. [Code of Conduct](#code-of-conduct)
8+
2. [Getting Started](#getting-started)
9+
3. [How to Contribute](#how-to-contribute)
10+
- [Reporting Issues](#reporting-issues)
11+
- [Submitting Pull Requests](#submitting-pull-requests)
12+
4. [Development Guidelines](#development-guidelines)
13+
- [Coding Standards](#coding-standards)
14+
- [Commit Messages](#commit-messages)
15+
- [Testing](#testing)
16+
5. [Getting Help](#getting-help)
17+
18+
## Code of Conduct
19+
20+
We are committed to fostering a welcoming and inclusive community. By participating in this project, you agree to abide by our [Code of Conduct](CODE-of-CONDUCT.md).
21+
22+
## Getting Started
23+
24+
1. **Fork the repository**: Create a fork of the repository by clicking the "Fork" button at the top right of the repository page.
25+
2. **Clone your fork**: Clone your fork to your local machine, see (https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository). In the terminal, one can use the following command:
26+
```sh
27+
git clone https://github.com/your-username/WeatherGenerator.git
28+
```
29+
3. **Set up the upstream remote**: Set up the upstream remote to keep your fork up-to-date with the main repository, see again (https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-repository-for-a-fork). In the terminal:
30+
```sh
31+
git remote add upstream https://github.com/ecmwf/WeatherGenerator.git
32+
```
33+
34+
## How to Contribute
35+
36+
### Reporting Issues
37+
38+
If you find a bug or have a feature request, please create an issue on the repository's [issue tracker](https://github.com/ecmwf/WeatherGenerator/issues).
39+
When reporting an issue, please use the appropriate issue template and provide as much detail as possible, including steps to reproduce the issue and any relevant logs or screenshots. Please take care not to share personal information in the issue tracker (e.g. usernames, passwords, hostnames, etc). Please use the appropriate tags to categorize your issue.
40+
41+
### Submitting Contributions
42+
43+
lease open first an issue on the repository's [issue tracker](https://github.com/ecmwf/WeatherGenerator/issues) that describes the contribution that you are planning. This can be bug fixes or new features. Having a discussion through the issue early on will ensure that your work aligns with the development roadmap for the WeatherGenerator project and that your PR will eventually be accepted.
44+
45+
#### Implementing and Submitting your Contribution
46+
47+
The WeatherGenerator project follows the standard process of pull requests on Github. If you are unfamiliar, consider following the [Github documentaion on pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests).
48+
Pull requests are expected to have a clear description of the issue. Any significant pull request is expected to have a Github issue associated.
49+
50+
1. **Create a branch**: Create a new branch for your work
51+
2. **Make your changes**: Make your changes in your feature branch.
52+
3. **Commit your changes**: Please use clear and descriptive commit messages.
53+
4. **Push to your fork**: Push your changes to your fork on GitHub
54+
5. **Open a pull request**: Open a pull request against the `develop` branch of the WeatherGenerator repository. Provide a clear description of your changes and link any relevant issues.
55+
56+
## Development Guidelines
57+
58+
### Coding Standards
59+
60+
Please follow our coding standards to ensure consistency across the codebase. Refer to our [Coding Standards](CODING_STANDARDS.md) document for details on the conventions and best practices we adhere to.
61+
62+
### Commit Messages
63+
64+
Write clear and concise commit messages that describe the changes made. Where possible and relevant, reference any related issues in the commit message.
65+
66+
### Testing
67+
68+
Ensure that your changes are thoroughly tested by:
69+
1. Running existing tests to ensure that they pass.
70+
2. Add or update unit tests as necessary to cover your changes.
71+
3. Make sure that all tests, new and old, pass before submitting a pull request.
72+
73+
74+
Thank you for contributing to the WeatherGenerator! Your contributions are greatly appreciated.
75+

0 commit comments

Comments
 (0)