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
docs: update readme and changelog #1510
Merged
armaniferrante
merged 2 commits into
coral-xyz:master
from
paul-schaaf:docs/readme-changelog
Feb 23, 2022
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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 |
---|---|---|
@@ -1,15 +1,45 @@ | ||
# Contributing to Anchor | ||
<div align="center"> | ||
<img height="170x" src="https://media.discordapp.net/attachments/813444514949103658/890278520553603092/export.png?width=746&height=746" /> | ||
|
||
<h1>Anchor</h1> | ||
</div> | ||
<br> | ||
|
||
Thank you for your interest in contributing to Anchor! All contributions are welcome no | ||
matter how big or small. This includes (but is not limited to) filing issues, | ||
adding documentation, fixing bugs, creating examples, and implementing features. | ||
|
||
If you'd like to contribute, please claim an issue by commenting, forking, and | ||
opening a pull request, even if empty. This allows the maintainers to track who | ||
is working on what issue as to not overlap work. If you're looking to get started, | ||
## Finding issues to work on | ||
|
||
If you're looking to get started, | ||
check out [good first issues](https://github.com/project-serum/anchor/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) | ||
or issues where [help is wanted](https://github.com/project-serum/anchor/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22). | ||
For simple documentation changes, feel free to just open a pull request. | ||
For simple documentation changes or typos, feel free to just open a pull request. | ||
|
||
If you're considering larger changes or self motivated features, please file an issue | ||
and engage with the maintainers in [Discord](https://discord.com/channels/889577356681945098). | ||
and engage with the maintainers in [Discord](https://discord.gg/sxy4zxBckh). | ||
|
||
## Choosing an issue | ||
|
||
If you'd like to contribute, please claim an issue by commenting, forking, and | ||
opening a pull request, even if empty. This allows the maintainers to track who | ||
is working on what issue as to not overlap work. | ||
|
||
## Issue Guidelines | ||
|
||
Please follow these guidelines: | ||
|
||
Before coding: | ||
- choose a branch name that describes the issue you're working on | ||
|
||
While coding: | ||
- Submit a draft PR asap | ||
- Only change code directly relevant to your PR. Sometimes you might find some code that could really need some refactoring. However, if it's not relevant to your PR, do not touch it. File an issue instead. This allows the reviewer to focus on a single problem at a time. | ||
- If you write comments, do not exceed 80 chars per line. This allows contributors who work with multiple open windows to still read the comments without horizontally scrolling. | ||
- Write adversarial tests. For example, if you're adding a new account type, do not only write tests where the instruction succeeds. Also write tests that test whether the instruction fails, if a check inside the new type is violated. | ||
|
||
After coding: | ||
- If you've moved code around, build the docs with `cargo doc --open` and adjust broken links | ||
- Adjust the cli templates if necessary | ||
- If you made a change to anchor's periphery (avm or cli), make a PR to the `anchor-book` repo if necessary | ||
- If you've added a new folder to the `tests` directory, add it to the [CI](./.github/workflows/tests.yaml). |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's the thought process for changing the headline? I prefer "Contributing to Anchor" over "Anchor", since this is indeed the contributing document.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similarly for the logo. Seems like we should remove it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
removed the headline by mistake