-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update CONTRIBUTING.md and issue/PR templates to support contributions
In short, I'm comfortable with the state of the language/compiler where outside contributions are manageable (both in terms of authoring/reviewing). This process will likely change over time, but at least for now I think this provides a good starting point.
- Loading branch information
1 parent
668cb47
commit c9d8b66
Showing
6 changed files
with
101 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| --- | ||
| name: "Bug Report" | ||
| about: "Report a bug or other unintended behavior" | ||
| title: "" | ||
| labels: "bug" | ||
| assignees: "" | ||
| --- | ||
|
|
||
| <!-- | ||
| BEFORE opening an issue, please confirm the following: | ||
| - There is not an open (or closed) issue for this bug. | ||
| - There is not a fixed merged and awaiting release (the online editor will | ||
| generally not have the latest commits). | ||
| - If you're unsure please ask me (@WillBAnders) via Discord. | ||
| WHEN opening an issue, please do the following: | ||
| - Include a meaningful description of the bug and the expected behavior. | ||
| - Include an example program that can be used to reproduce the bug. | ||
| AFTER opening an issue, please do the following: | ||
| - Keep an eye out for comments and respond in a timely fashion, particularly | ||
| regarding clarifying information needed to triage the issue. | ||
| - If your issue has not been triaged (say after a few days), tag me on Discord | ||
| as a reminder. I will try to keep the issue updated on status, but fixing the | ||
| bug itself may take time. | ||
| - I will _not_ close issues as stale so long as I can reproduce it. | ||
| --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| --- | ||
| name: "Feature Request" | ||
| about: "Suggest a new feature or other addition" | ||
| title: "" | ||
| labels: "feature" | ||
| assignees: "" | ||
| --- | ||
|
|
||
| <!-- | ||
| BEFORE opening an issue, please confirm the following: | ||
| - There is not an open (or closed) issue for this feature. | ||
| - There is not an implementation merged and awaiting release (the online editor | ||
| will generally not have the latest commits). | ||
| - If you're unsure please ask me (@WillBAnders) via Discord. | ||
| WHEN opening an issue, please do the following: | ||
| - Include a meaningful description of the feature, particularly around key | ||
| areas like motivation, edge cases, and consequences/tradeoffs. | ||
| - Include an example program (or more as needed) demonstrating the feature. | ||
| AFTER opening an issue, please do the following: | ||
| - Keep an eye out for comments and respond in a timely fashion, particularly | ||
| regarding clarifying information needed to understand the feature request. | ||
| - If your issue has not been triaged (say after a few days), tag me on Discord | ||
| as a reminder. I will try to keep the issue updated on status, but adding the | ||
| feature itself may take time. | ||
| - I will _not_ close issues as stale so long as it is under consideration. | ||
| --> |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| --- | ||
| name: "NOTICE: Questions should NOT be asked through GitHub" | ||
| about: "Please ask questions through our Discord server" | ||
| title: "" | ||
| labels: "" | ||
| assignees: "" | ||
| --- | ||
|
|
||
| # NOTICE: Questions should NOT be asked through GitHub | ||
|
|
||
| Questions about Rhovas should be directed to our [Discord Server](https://discord.gg/gm96xd8). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,20 @@ | ||
| # NOTICE: PRs are currently NOT accepted | ||
| <!-- | ||
| BEFORE opening a PR, please confirm the following: | ||
| - You've discussed this PR with me (@WillBAnders), e.g. via Discord. | ||
| - In general, there is an open issue for the associated bug/feature. | ||
| At this time, we are not accepting PRs to this repository until the core | ||
| language has been established and is ready for more detailed review. There is a | ||
| lot of work on Rhovas which is undocumented, and our focus needs to be on | ||
| creating that initial implementation so we can support community contributions. | ||
| WHEN opening a PR, please do the following: | ||
| - Include a meaningful description of your code change, particularly around | ||
| key areas like bugfix solution and design decisions. | ||
| - Ensure there are tests added covering your changes. | ||
| - Link any associated open issue for the associated bug/feature. | ||
| - Enable "Allow edits from maintainers", which allows me to make changes on | ||
| your branch. This is mainly intended for final nitpicks like styling or test | ||
| coverage, but also allows me to finish PRs (and give credit for said changes) | ||
| if they end up abandoned. | ||
| Until then, the best way to contribute to the implementation of Rhovas right | ||
| now is to ask questions and provided feedback on the language in our | ||
| [Discord Server](https://discord.gg/gm96xd8). | ||
| AFTER opening a PR, please do the following: | ||
| - Keep an eye out for comments/reviews and respond in a timely fashion. | ||
| - If I'm behind on comments/reviews (say a few days), tag me on Discord as a | ||
| reminder (I normally respond quickly, but forget to circle back later on). | ||
| --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,19 @@ | ||
| # Contributing | ||
|
|
||
| Thank you for your interest in contributing! The best way to contribute to the | ||
| implementation of Rhovas right now is to ask questions and provided feedback on | ||
| the language in our [Discord Server](https://discord.gg/gm96xd8). | ||
| Thank you for your interest in contributing! Please note that Rhovas is still a | ||
| pretty new language and largely a one-person project, however there are two main | ||
| ways you can contribute: | ||
|
|
||
| - Try writing example programs in Rhovas (the [Online Editor](https://rhovas.dev/editor/) | ||
| may help here) and provide feedback to help improve the language. Feel free | ||
| to ask in [Discord](https://discord.gg/gm96xd8) if you're not sure how to | ||
| accomplish something or come across a bug. | ||
| - If you're looking for ideas we have a [RosettaCode page](https://rosettacode.org/wiki/Category:Rhovas) | ||
| that's a little short on solutions. We also use these as test cases that | ||
| represent practical programs, so it helps in that way too! | ||
| - For code contributions, you're welcome to work on any open issue or propose | ||
| something new if there's a feature you're waiting on. In general, please make | ||
| sure to keep me (`@WillBAnders`) in the loop so I know what's being worked on | ||
| and can provide guidance along the way - communication is key! | ||
|
|
||
| If you have any questions, feel free to ask in our [Discord Server](https://discord.gg/gm96xd8). |