Skip to content

Commit 10fba76

Browse files
committed
Emphasize the use of American English and filing an issue
1 parent cc50a1f commit 10fba76

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,24 @@ Use your best judgment, and feel free to propose changes to this document in a p
1111
This project uses GitHub Issues to track ongoing development, discuss project plans, and keep track of bugs.
1212
Be sure to search for existing issues before you create another one.
1313

14+
Initially, it is advisable to create an issue on GitHub for bug reports, feature requests,
15+
or substantial pull requests, as this offers a platform for discussion with both the community and project maintainers.
16+
17+
Engaging in a conversation through a GitHub issue before making a contribution is crucial to ensure the acceptance of your work.
18+
We aim to prevent situations where significant effort is expended on a pull request that might not align with the project's design principles.
19+
For example, it might turn out that the feature you propose is more suited as an independent module that complements this project,
20+
in which case we would recommend that direction.
21+
22+
For minor corrections, such as typo fixes, small refactoring, or updates to documentation/comments,
23+
filing an issue is not typically necessary.
24+
What constitutes a "minor" fix involves discretion; however, examples include:
25+
- Correcting spelling mistakes
26+
- Minor code refactoring
27+
- Updating or editing documentation and comments
28+
29+
Nevertheless, there may be instances where, upon reviewing your pull requests,
30+
we might request an issue to be filed to facilitate discussion on broader design considerations.
31+
1432
Visit our [Issues page on GitHub](https://github.com/sysprog21/rv32emu/issues) to search and submit.
1533

1634
## Coding Convention
@@ -21,6 +39,10 @@ However, participation requires adherence to fundamental ground rules:
2139
While there is some flexibility in basic style, it is crucial to stick to the current coding standards.
2240
Complex algorithmic constructs without proper comments will not be accepted.
2341
* External pull requests should include thorough documentation in the pull request comments for consideration.
42+
* When composing documentation, code comments, and other materials in English,
43+
please adhere to the American English (`en_US`) dialect.
44+
This variant should be considered the standard for all documentation efforts.
45+
For instance, opt for "initialize" over "initialise" and "color" rather than "colour".
2446

2547
Software requirement: [clang-format](https://clang.llvm.org/docs/ClangFormat.html) version 12 or later.
2648

0 commit comments

Comments
 (0)