Skip to content

Commit e7538e7

Browse files
Merge pull request #1 from amd/enhancement/doc-updates
update contribution guidelines
2 parents 63033e3 + 6f6cfc5 commit e7538e7

File tree

1 file changed

+9
-13
lines changed

1 file changed

+9
-13
lines changed

CONTRIBUITING.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
# Contribute to Scraper
1+
# Contribute to Node Scraper
22

33
AMD values and encourages contributions to our code and documentation. If you want to contribute
44
to our repository, first review the following guidance.
55

66
## Development workflow
77

8-
Scraper uses GitHub to host code, collaborate, and manage version control. We use pull requests (PRs)
8+
Node Scraper uses GitHub to host code, collaborate, and manage version control. We use pull requests (PRs)
99
for all changes within our repository. We use
10-
[GitHub issues](https://github.com/<placeholder>/issues) to track known issues, such as
10+
[GitHub issues](https://github.com/amd/node-scraper/issues) to track known issues, such as
1111
bugs.
1212

1313
### Issue tracking
1414

1515
Before filing a new issue, search the
16-
[existing issues](https://github.com/<placeholder>/issues) to make sure your issue isn't
16+
[existing issues](https://github.com/amd/node-scraper/issues) to make sure your issue isn't
1717
already listed.
1818

1919
General issue guidelines:
@@ -33,12 +33,12 @@ General issue guidelines:
3333
### Pull requests
3434

3535
When you create a pull request, you should target the default branch. Our repository uses the
36-
**develop** branch as the default integration branch.
36+
**development** branch as the default integration branch.
3737

3838
When creating a PR, use the following process.
3939

4040
* Identify the issue you want to fix
41-
* Target the default branch (usually the **develop** branch) for integration
41+
* Target the default branch (usually the **development** branch) for integration
4242
* Ensure your code builds successfully
4343
* Do not break existing test cases
4444
* New functionality is only merged with new unit tests
@@ -52,12 +52,8 @@ When creating a PR, use the following process.
5252
> By creating a PR, you agree to allow your contribution to be licensed under the
5353
> terms of the LICENSE.txt file.
5454
55-
### New feature development
56-
57-
Use the [GitHub Discussion forum](https://github.com/<placeholder>/discussions)
58-
5955
### Documentation
6056

61-
Submit Scraper documentation changes to our
62-
[documentation](https://github.com/<placeholder>). You must update
63-
documentation related to any new feature or API contribution.
57+
Submit Node Scraper documentation changes to our
58+
[documentation](https://github.com/amd/node-scraper/development/README.md). You must update
59+
documentation related to any new feature or API contribution.

0 commit comments

Comments
 (0)