From 2c7a4056f42c90d041051095073aa1cda90c95ca Mon Sep 17 00:00:00 2001 From: Roland Kaminski Date: Thu, 2 Nov 2023 17:47:56 +0100 Subject: [PATCH 1/7] add file explainig how to contribute --- CONTRIBUTING.md | 111 ++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 1 + 2 files changed, 112 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..fd326d572 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,111 @@ +# Contributing to Clingo + +First off, thanks for taking the time to contribute! ❤️ + +All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉 + +> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about: +> - Star the project +> - Tweet about it +> - Refer this project in your project's readme +> - Mention the project at local meetups and tell your friends/colleagues + + +## Table of Contents + +- [I Have a Question](#i-have-a-question) +- [I Want To Contribute](#i-want-to-contribute) + - [Reporting Bugs](#reporting-bugs) + - [Suggesting Enhancements](#suggesting-enhancements) + - [Your First Code Contribution](#your-first-code-contribution) + - [Improving The Documentation](#improving-the-documentation) + + +## I Have a Question + +> If you want to ask a question, we assume that you have read the available [Documentation](https://potassco.org/support). + +Before you ask a question, it is best to search for existing [issues](https://github.com/potassco/clingo/issues) or [messages](https://sourceforge.net/p/potassco/mailman/potassco-users/) in the archive of our mailing list. + +If you then still feel the need to ask a question and need clarification, we recommend the following: + +- [Subscribe](https://sourceforge.net/projects/potassco/lists/potassco-users) on sourceforge or open an [issue](https://github.com/potassco/clingo/issues/new) on github. +- Provide as much context as you can about what you're running into. +- We can best help you if you provide executable code showcasing your problem. + +We will then take care of the issue as soon as possible. + +## I Want To Contribute + +> ### Legal Notice +> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. + +### Reporting Bugs + + +#### Before Submitting a Bug Report + +A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible. + +- Make sure that you are using the latest version. +- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://potassco.org/support/). If you are looking for support, you might want to check [this section](#i-have-a-question)). +- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/potassco/clingo/issues?q=label%3Abug). +- Collect information about the bug + - OS, Platform and Version (Windows, Linux, macOS, x86, ARM) + - Possibly your input and the output + - Can you reliably reproduce the issue? And can you also reproduce it with older versions? + - Stack trace (Traceback) + + +#### How Do I Submit a Good Bug Report? + +We use GitHub issues to track bugs and errors. If you run into an issue with the project: + +- Open an [Issue](https://github.com/potassco/clingo/issues/new). +- Explain the behavior you would expect and the actual behavior. +- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case. +- Provide the information you collected in the previous section. + +Once it's filed: + +- The project team will label the issue accordingly. +- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps. +- If the team is able to reproduce the issue, the issue will be left to be [implemented by someone](#your-first-code-contribution). + +### Suggesting Enhancements + +This section guides you through submitting an enhancement suggestion for Clingo, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions. + + +#### Before Submitting an Enhancement + +- Make sure that you are using the latest version. +- Read the [documentation](https://potassco.org) carefully and find out if the functionality is already covered, maybe by an individual configuration. +- Perform a [search](https://github.com/potassco/clingo/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. +- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library. + + +#### How Do I Submit a Good Enhancement Suggestion? + +Enhancement suggestions are tracked as [GitHub issues](https://github.com/potassco/clingo/issues). + +- Use a **clear and descriptive title** for the issue to identify the suggestion. +- Provide a **step-by-step description of the suggested enhancement** in as many details as possible. +- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you. +- **Explain why this enhancement would be useful** to most Clingo users. You may also want to point out the other projects that solved it better and which could serve as inspiration. + +### Your First Code Contribution + + +### Improving The Documentation + + +## Attribution +This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)! + diff --git a/README.md b/README.md index 3d204a84b..6b58c57e7 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ Please consult the following resources for further information: - [**Downloading source and binary releases**](https://github.com/potassco/clingo/releases) - [**Installation and software requirements**](INSTALL.md) + - [**Contributions**](CONTRIBUTING.md) - [Changes between releases](CHANGES.md) - [Documentation](https://github.com/potassco/guide/releases) - [Potassco clingo page](https://potassco.org/clingo/) From c73b086c99559c6b40b149b029c2a932ec25d6d6 Mon Sep 17 00:00:00 2001 From: Roland Kaminski Date: Thu, 2 Nov 2023 18:05:07 +0100 Subject: [PATCH 2/7] some more text --- CONTRIBUTING.md | 24 ++++++++---------------- 1 file changed, 8 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fd326d572..d8045c6e4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,7 +29,7 @@ Before you ask a question, it is best to search for existing [issues](https://gi If you then still feel the need to ask a question and need clarification, we recommend the following: -- [Subscribe](https://sourceforge.net/projects/potassco/lists/potassco-users) on sourceforge or open an [issue](https://github.com/potassco/clingo/issues/new) on github. +- [Subscribe](https://sourceforge.net/projects/potassco/lists/potassco-users) to our mailing list on SourceForge or open an [issue](https://github.com/potassco/clingo/issues/new) on GitHub. - Provide as much context as you can about what you're running into. - We can best help you if you provide executable code showcasing your problem. @@ -40,6 +40,10 @@ We will then take care of the issue as soon as possible. > ### Legal Notice > When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. +### Code Contributions + +To contribute to Clingo, please fork the repository and **open a pull request to the wip branch**. We do not accept pull requests to the master. They will have to be rebased. We currently do not enforce coding styles. Please try to match the existing one as best as possible. To avoid unnecessary work, you can reach out to use to discuss your contribution via one of the ways described here. + ### Reporting Bugs @@ -80,32 +84,20 @@ This section guides you through submitting an enhancement suggestion for Clingo, #### Before Submitting an Enhancement - Make sure that you are using the latest version. -- Read the [documentation](https://potassco.org) carefully and find out if the functionality is already covered, maybe by an individual configuration. -- Perform a [search](https://github.com/potassco/clingo/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. +- Read the [documentation](https://potassco.org/support) carefully and find out if the functionality is already covered, maybe by an individual configuration. +- Perform a [search](https://github.com/potassco/clingo/discussions) to see if the enhancement has already been suggested. If it has, add a comment to an existing discussion instead of opening a new one. - Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library. #### How Do I Submit a Good Enhancement Suggestion? -Enhancement suggestions are tracked as [GitHub issues](https://github.com/potassco/clingo/issues). +Enhancement suggestions are tracked as [GitHub discussions](https://github.com/potassco/clingo/discussions). - Use a **clear and descriptive title** for the issue to identify the suggestion. - Provide a **step-by-step description of the suggested enhancement** in as many details as possible. - **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you. - **Explain why this enhancement would be useful** to most Clingo users. You may also want to point out the other projects that solved it better and which could serve as inspiration. -### Your First Code Contribution - - -### Improving The Documentation - - ## Attribution This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)! From 2eedc4c137d153d158c628e481a521582da83a87 Mon Sep 17 00:00:00 2001 From: Roland Kaminski Date: Thu, 2 Nov 2023 18:08:40 +0100 Subject: [PATCH 3/7] refine --- CONTRIBUTING.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d8045c6e4..20814a1a2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,15 +13,14 @@ All types of contributions are encouraged and valued. See the [Table of Contents ## Table of Contents -- [I Have a Question](#i-have-a-question) -- [I Want To Contribute](#i-want-to-contribute) +- [Asking Question](#asking-questions) +- [Contributing](#contributing) + - [Contributing Code](#contributing-code) - [Reporting Bugs](#reporting-bugs) - [Suggesting Enhancements](#suggesting-enhancements) - - [Your First Code Contribution](#your-first-code-contribution) - - [Improving The Documentation](#improving-the-documentation) -## I Have a Question +## Asking Questions > If you want to ask a question, we assume that you have read the available [Documentation](https://potassco.org/support). @@ -35,12 +34,12 @@ If you then still feel the need to ask a question and need clarification, we rec We will then take care of the issue as soon as possible. -## I Want To Contribute +## Contributing > ### Legal Notice > When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. -### Code Contributions +### Contributing Code To contribute to Clingo, please fork the repository and **open a pull request to the wip branch**. We do not accept pull requests to the master. They will have to be rebased. We currently do not enforce coding styles. Please try to match the existing one as best as possible. To avoid unnecessary work, you can reach out to use to discuss your contribution via one of the ways described here. @@ -100,4 +99,3 @@ Enhancement suggestions are tracked as [GitHub discussions](https://github.com/p ## Attribution This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)! - From a66a538c14029dd78bdea6085aad609c0ff4378c Mon Sep 17 00:00:00 2001 From: Roland Kaminski Date: Thu, 2 Nov 2023 18:10:43 +0100 Subject: [PATCH 4/7] more refinements --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 20814a1a2..cd64fe478 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,7 +41,7 @@ We will then take care of the issue as soon as possible. ### Contributing Code -To contribute to Clingo, please fork the repository and **open a pull request to the wip branch**. We do not accept pull requests to the master. They will have to be rebased. We currently do not enforce coding styles. Please try to match the existing one as best as possible. To avoid unnecessary work, you can reach out to use to discuss your contribution via one of the ways described here. +To contribute to Clingo, please fork the repository and **open a pull request to the wip branch**. We do not accept pull requests to the master. They will have to be rebased. We currently do not enforce coding styles. Please try to match the existing one as best as possible. To avoid unnecessary work, you can reach out to use to discuss your contribution via one of the ways described below. ### Reporting Bugs From c32f1a4b44d423d8b447ac690f5b9502af45132b Mon Sep 17 00:00:00 2001 From: Roland Kaminski Date: Thu, 2 Nov 2023 18:29:48 +0100 Subject: [PATCH 5/7] update --- CONTRIBUTING.md | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cd64fe478..10b20d507 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,7 +41,7 @@ We will then take care of the issue as soon as possible. ### Contributing Code -To contribute to Clingo, please fork the repository and **open a pull request to the wip branch**. We do not accept pull requests to the master. They will have to be rebased. We currently do not enforce coding styles. Please try to match the existing one as best as possible. To avoid unnecessary work, you can reach out to use to discuss your contribution via one of the ways described below. +To contribute to Clingo, please fork the repository and **open a pull request to the wip branch**. We do not accept pull requests to the master. They will have to be rebased. We currently do not enforce coding styles. Please try to match the existing one as best as possible. To avoid unnecessary work, you can reach out to us to discuss your contribution via one of the ways described below. ### Reporting Bugs diff --git a/README.md b/README.md index 6b58c57e7..52eab729a 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Please consult the following resources for further information: - [**Downloading source and binary releases**](https://github.com/potassco/clingo/releases) - [**Installation and software requirements**](INSTALL.md) - - [**Contributions**](CONTRIBUTING.md) + - [**Contributing**](CONTRIBUTING.md) - [Changes between releases](CHANGES.md) - [Documentation](https://github.com/potassco/guide/releases) - [Potassco clingo page](https://potassco.org/clingo/) From 670900ab6c61c1838e08ab6469ed7f8e468b2669 Mon Sep 17 00:00:00 2001 From: Roland Kaminski Date: Thu, 2 Nov 2023 18:41:13 +0100 Subject: [PATCH 6/7] add PR template --- .github/pull_request_template.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..a631feb99 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,7 @@ +### Checklist + +**Please only open Pull Requests against the wip branch** + +[ ] Have you followed the guidelines in our [CONTRIBUTING.md](/potassco/clingo/blob/contributing/CONTRIBUTING.md) document? +[ ] Have you checked to ensure there aren't other open Pull Requests for the same update/change? +[ ] Have you made sure that all tests succeed? From e5341151ef773535407ae24c6bb3972367c05181 Mon Sep 17 00:00:00 2001 From: Roland Kaminski Date: Thu, 23 Nov 2023 12:33:06 +0100 Subject: [PATCH 7/7] update changes --- CHANGES.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGES.md b/CHANGES.md index 747fe8fdf..ef4b12e84 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -10,6 +10,7 @@ * improve hash table performance (#441) * extend add_theory_atom method of backend (#461) (breaks backward compatibility of the API) + * add contribution guidelines (#465) * fix `add_theory_atom_with_guard` in Python API * fix AST bugs (#403) * fix parsing of hexadecimal numbers (#421)