-
Notifications
You must be signed in to change notification settings - Fork 5
chore(docs): Adding contributing guidelines #153
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
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
bbc70bb
adding contributing guidelines
mpoke a925774
add config for unclog
mpoke e6120cb
apply suggestions
mpoke 91fdbb7
Merge branch 'main' into marius/contributing
mpoke 5d6b1b7
Update CONTRIBUTING.md
mpoke 17e1862
Merge branch 'main' into marius/contributing
mpoke bc7ceba
Merge branch 'main' into marius/contributing
mpoke File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,7 @@ | ||
| project_url = "https://github.com/informalsystems/emerald" | ||
|
|
||
| # The number of spaces to inject before each component-related entry. | ||
| entry_indent = 2 | ||
|
|
||
| [change_set_sections] | ||
| sort_entries_by = "entry-text" |
This file contains hidden or 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,88 @@ | ||
| # Contributing to Emerald | ||
|
|
||
| Thanks for your interest in contributing to Emerald. We welcome issues, discussions, and pull requests from the community. | ||
|
|
||
| **The [Telegram group][tg] is available for any concerns you may have that are not covered in this guide.** | ||
|
|
||
| ## Getting Started | ||
|
|
||
| 1. Fork the repository and create your branch from `main`. | ||
| 2. Make sure the project builds and tests pass locally. | ||
| 3. Keep changes focused and well-scoped. | ||
|
|
||
| ## Reporting Issues | ||
|
|
||
| - Use GitHub Issues to report bugs or request features. | ||
| - Search existing issues before opening a new one. | ||
| - Provide clear reproduction steps and relevant context. | ||
|
|
||
| ## Submitting Changes | ||
|
|
||
| **Note:** Ideally, a pull request should address an issue that clearly motivates the changes introduced by the pull request. | ||
|
|
||
| - Open a pull request with a clear description of the change. | ||
| - Reference related issues where applicable. | ||
| - Follow existing code style and conventions. | ||
| - Add or update tests when appropriate. | ||
| - Update documentation if behavior or interfaces change. | ||
mpoke marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - Add a changelog entry (see [Changelog](#changelog) section for details) | ||
|
|
||
| ### Changelog | ||
|
|
||
| To manage and generate our changelog, we currently use [unclog](https://github.com/informalsystems/unclog). | ||
|
|
||
| Every PR with types `fix`, `feat`, `deps`, and `refactor` should include a file | ||
| `.changelog/unreleased/${section}/${pr-number}-${short-description}.md`, | ||
| where: | ||
|
|
||
| - `section` is one of | ||
| `dependencies`, `improvements`, `features`, `bug-fixes`, `state-breaking`, `api-breaking`, | ||
| and _**if multiple apply, create multiple files**_, | ||
| not necessarily with the same `short-description` or content; | ||
| - `pr-number` is the PR number; | ||
| - `short-description` is a short (4 to 6 word), hyphen separated description of the change. | ||
|
|
||
| For examples, see the [.changelog](.changelog) folder. | ||
|
|
||
| Use `unclog` to add a changelog entry in `.changelog` (check the [requirements](https://github.com/informalsystems/unclog#requirements) first): | ||
| ```bash | ||
| unclog add \ | ||
| -i "${pr-number}-${short-description}" \ | ||
| -p "${pr-number}" \ | ||
| -s "${section}" \ | ||
| -m "${description}" \ | ||
| ``` | ||
| where `${description}` is a detailed description of the changelog entry. | ||
|
|
||
| For example, | ||
| ```bash | ||
| unclog add -i "136-deployment-with-more-nodes" -p 136 -s features -m "Scripts can now generate setup for more than 4 nodes" | ||
| ``` | ||
|
|
||
| **Note:** `unclog add` requires an editor. This can be set either by configuring | ||
| an `$EDITOR` environment variable or by manually specifying an editor binary path | ||
| via the `--editor` flag. | ||
|
|
||
| **Note:** Changelog entries should answer the question: "what is important about this | ||
| change for users to know?" or "what problem does this solve for users?". It | ||
| should not simply be a reiteration of the title of the associated PR, unless the | ||
| title of the PR _very_ clearly explains the benefit of a change to a user. | ||
|
|
||
mpoke marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## Code Review | ||
|
|
||
| - All submissions require review before merging. | ||
| - Be responsive to feedback and open to discussion. | ||
| - Maintainers may request changes to ensure quality and consistency. | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| By participating, you agree to follow the project's Code of Conduct. | ||
|
|
||
| The Emerald project adheres to the [Rust Code of Conduct][rust-coc]. This code of conduct describes the minimum behavior expected from all contributors. | ||
|
|
||
| ## License | ||
|
|
||
| By contributing, you agree that your contributions will be licensed under the same license as the project. | ||
|
|
||
| [rust-coc]: https://rust-lang.org/policies/code-of-conduct/ | ||
| [tg]: https://t.me/+uHIbcHYVbA44NzNh | ||
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.